API文档翻译指南

很高兴你有兴趣参与maptalks的API文档翻译工作！

目前maptalks的API文档是通过代码注释自动生成的，文档生成工具是JSDOC 3，api文档的模板是maptalks-jsdoc

为API文档添加中文翻译的步骤：

• fork maptalks.js仓库到自己的账号下
• 在fork后的maptalks.js项目中新建一个分支，例如叫zh-CN
• 为src目录里的源代码中添加中文翻译，例如：

    /**
     * Get map's current zoom.
     * 返回地图当前的缩放级别
     * @return {Number}
     */
    getZoom() {
        return this._zoomLevel;
    }

• 如必要，在本地生成api文档，检查实际效果。 在maptalks.js项目根目录下运行：

npm run doc

api文档会生成在docs/api/0.x/目录下

请注意，doc任务在(windows 10 + node 8.x)下可能会因为没有权限删除文件而报错，推荐使用node 6.x

• 将src中的改动提交pull request到maptalks.js主库

注意只提交src目录下的内容，不要提交docs下的任何文件