注：文档正在翻译中，译者会逐步填充。
- Index
- 起步
- 使用 JSDoc 3 添加文档注释 - 快速学习使用 JSDoc 给 JavaScript 添加文档注释
- License - JSDoc 3 软件许可
- package.json - 如何在文档中添加
package.json - README - 如何在文档中添加
README
- JSDoc 示例
- ES 2015 类 - 如何给 ECMAScript 2015中的类添加JSDoc注释
- ES 2015 模块 - 如何给 ECMAScript 2015中的模块添加JSDoc注释
- 块标签(Block Tags)
- @abstract(同义词：@virtual) - 该标识符必须被继承者实现(或者复写)
- @access - 指定成员的访问等级(private, package-private, public, 或者 protected)
- @alias - 给一个变量添加别名
- @async - 标示一个方法是异步的
- @augments(同义词：@extends) - 标记一个标识符继承自、添加到父标识符
- @author - 标记某项的作者
- @borrows - 一个对象引用另外一个对象的文档注释
- @class(同义词：@constructor) - 该方法期望被
new关键字进行构造调用 - @classdesc - 使用下面的文字描述整个类
- @constant(同义词：@const) - 将一个对象标记为常量
- @constructs - 该方法是前面类的构造器函数
- @copyright - 标记版权信息
- @default(同义词：@defaultvalue) - 标记默认值
- @deprecated - 标记一个项不应该继续使用
- @enum - 标记一组相关的属性
- @event - 标记事件
- @example - 提供一个如何使用已标记项目的示例
- @exports - 标记模块导出的成员属性
- @file(同义词：@fileoverview, @overview) - 描述文件
- @fires(同义词：@func, @method) - 描述该方法会触发的事件
- @function(同义词：@emits) - 描述一个函数或者方法
- @global - 标记一个全局对象
- @ignore - 使一个标识符不出现在文档中
- @inner - 标记一个内部对象
- @kind - 标识一个可以被其他标识符实现的接口
- @kind(同义词：@emits) - 标示标识符的种类
- @lends - 给对象字面量中的属性添加文档注释，就像这些属性属于一个给定名称的标识符一样
- @license - 标识该项目中代码使用的软件许可
- @listens - 列出一个标识符监听的所有事件
- @member - 标记一个成员
- @memberof - 当前标识符属于另外一个父标识符
- @mixes - 该对象会将另外一个对象的所有成员混入
- @mixin - 标记一个混入对象
- @name - 标记对象的名字
- @override - 标示一个标识符重写了父类中的同名标识符
- @package - 标记一个标识符是 包私有的
- @private - 标记一个标识符是私有的
- @property(同义词： @prop) - 标记对象的属性
- @public - 该标识符为 public 修饰
- @readonly - 标示该标识符是只读的
- @returns(同义词：@return) - 给函数的返回值添加文档注释
- @see - 引用其他文档注释
- @since - 标记该特性是在哪个版本加入的
- @since - 标记一个静态成员
- @summary - 简短版的完整描述
- @this - 关键字 'this' 的指向
- @throws(同义词：@exception) - 标记可能抛出的异常
- @todo - 标记未完成的任务
- @tutorial - 插入一个指向教程文件的链接
- @typedef - 标记自定义类型
- @version - 标记一个项的版本号
- @yields(同义词：@yield) - 给 generator 函数的生成值添加文档注释
- 内联标签(inline tags)
- @inline-link(同义词： {@linkcode}, {@linkplain}) - 在文档内链接到其他项的文档
- 起步
该仓库所有文件翻译自JSDoc英文文档，如有版权问题请联系作者。
侵删。
如内容有错误，敬请斧正。
译者邮箱：web.taox@gmail.com
- GitHub
- Email: web.taox@gmail.com