6. 翻译规范

此文档会根据翻译情况持续完善

1. 任务要求

• 翻译所有能够被jsduck扫描出来的注释(语法说明).
• 尽量保证翻译后的代码行号与原文一致，如果原来的两句注释翻译后变成一句，尽量分两行写或者保留一个空行.
• 由于最终发布的是源码, 所以最好 行内注释 也翻译一下(此项可选).

以下内容不翻译

• 注释中的参数名，方法名，类名，包名等源码相关元素
• 专有名词
• 常见简称：id HTML js this 等等

2. 署名

为了提高对源码统计的效率, 署名必须 **严格 ** 按照以下格式编写, 并放置在类定义上面的块注释中:

 * @docauthor 译者: [名称]<[邮箱地址]>

建议直接copy例子中的格式, 因为 标点 也需要对.

注意署名单独一行, 且开头有个 空格, 而结尾没有. 译者信息添加到顶部, 放在原作者下面. 具体例子如下:

/**
 * @docauthor 译者: 老男孩<[email protected]>
 * 表示RGB颜色, 并提供辅助函数用于色彩空间RGB与HSL之间的转换.
 */
Ext.define('Ext.draw.Color', {

3. 公共词组字典

• 把不准的词都可以群里面讨论,然后由老男孩加入字典表
• Class：类
• Subclasses：子类
• Method：方法
• parameter：参数
• Usage：用法
• Global：全局
• Scope：作用域
• event handler：事件处理函数
• event listener：事件监听器
• utility class：工具类
• see also：参见
• Example：示例
• Drag 拖动
• Drop 放下\或拖到，(请参考上下文)
• Frame 框架
• Behavior 行为
• Valid Properties 有效属性
• Cursor Offset 光标偏移
• Blow Up 崩溃
• Overrides 重写,覆盖
• Disabled 禁用
• Auto-repair 自动修复
• Internal typeof flag 内置的typeof运算符标志
• contraints 约束
• handle 处理，处理函数
• required 必需的
• mixin 混入

4. 编码格式

翻译后的源文件要注意编码格式, 原来文件的编码格式为ANSI, 翻译后统一要求为 UTF-8 + BOM

5. 特别说明

此项为针对翻译中碰到的现象进行特别说明

• @private 为doc的语法之一, 不需要翻译为 @私有