JSDoc 中文网

入门

JSDoc 入门: 使用 JSDoc 快速开始记录 JavaScript。
将名称路径与 JSDoc 一起使用: 在 JSDoc 中使用名称路径的指南。
JSDoc 的命令行参数: 关于 JSDoc 的命令行参数。
使用配置文件配置 JSDoc: 如何使用配置文件配置 JSDoc。
配置 JSDoc 的默认模板: 如何配置 JSDoc 默认模板的输出。
块标签和内联标签: 块和内联 JSDoc 标签概述。
关于 JSDoc 插件: 如何创建和使用 JSDoc 插件。
使用 Markdown 插件: 在 JSDoc 中启用 Markdown 支持。
教程: 将教程添加到你的 API 文档中。
包含包文件: 如何在文档中显示包详细信息。
包括自述文件: 如何在文档中包含自述文件。
许可: JSDoc 的许可证信息。

JSDoc 示例

ES 2015 课程: 如何向 ECMAScript 2015 类添加 JSDoc 注释。
ES 2015 模块: 如何向 ECMAScript 2015 模块添加 JSDoc 注释。
CommonJS 模块: 如何向 CommonJS 和 Node.js 模块添加 JSDoc 注释。
AMD 模块: 如何向 AMD 和 RequireJS 模块添加 JSDoc 注释。

块标签

@abstract (synonyms: @virtual): 该成员必须由继承者实现（或重写）。
@access: 指定该成员的访问级别（私有、包私有、公共或受保护）。
@alias: 将成员视为有不同的名称。
@async: 表明函数是异步的。
@augments (synonyms: @extends): 指示符号继承自父符号并添加到父符号。
@author: 识别项目的作者。
@borrows: 该对象使用另一个对象的某些内容。
@class (synonyms: @constructor): 该函数旨在使用 "new" 关键字调用。
@classdesc: 使用以下文本描述整个类。
@constant (synonyms: @const): 将对象记录为常量。
@constructs: 该函数成员将是前一个类的构造函数。
@copyright: 记录一些版权信息。
@default (synonyms: @defaultvalue): 记录默认值。
@deprecated: 记录这不再是首选方式。
@description (synonyms: @desc): 描述一个符号。
@enum: 记录相关属性的集合。
@event: 记录一个事件。
@example: 提供如何使用记录项目的示例。
@exports: 标识由 JavaScript 模块导出的成员。
@external (synonyms: @host): 标识外部类、命名空间或模块。
@file (synonyms: @fileoverview, @overview): 描述一个文件。
@fires (synonyms: @emits): 描述此方法可能触发的事件。
@function (synonyms: @func, @method): 描述一个函数或方法。
@generator: 表明函数是生成器函数。
@global: 记录全局对象。
@hideconstructor: 指示不应显示构造函数。
@ignore: 省略文档中的符号。
@implements: 该符号实现一个接口。
@inheritdoc: 指示符号应继承其父级的文档。
@inner: 记录内部对象。
@instance: 记录实例成员。
@interface: 该符号是其他人可以实现的接口。
@kind: 这是一个什么样的符号？
@lends: 记录对象字面量上的属性，就好像它们属于具有给定名称的符号一样。
@license: 确定适用于此代码的许可证。
@listens: 列出符号监听的事件。
@member (synonyms: @var): 记录成员。
@memberof: 该符号属于父符号。
@mixes: 该对象混合了另一个对象的所有成员。
@mixin: 记录一个 mixin 对象。
@module: 记录 JavaScript 模块。
@name: 记录对象的名称。
@namespace: 记录命名空间对象。
@override: 指示符号覆盖其父符号。
@package: 该符号是包私有的。
@param (synonyms: @arg, @argument): 记录函数的参数。
@private: 该符号是私有的。
@property (synonyms: @prop): 记录对象的属性。
@protected: 该符号应受到保护。
@public: 该符号应公开。
@readonly: 该符号是只读的。
@requires: 该文件需要 JavaScript 模块。
@returns (synonyms: @return): 记录函数的返回值。
@see: 请参阅其他一些文档以获取更多信息。
@since: 这个功能是什么时候添加的？
@static: 记录静态成员。
@summary: 完整描述的简短版本。
@this: 这里的 'this' 关键字指的是什么？
@throws (synonyms: @exception): 描述可能引发哪些错误。
@todo: 记录要完成的任务。
@tutorial: 插入指向所包含教程文件的链接。
@type: 记录对象的类型。
@typedef: 记录自定义类型。
@variation: 区分具有相同名称的不同对象。
@version: 记录项目的版本号。
@yields (synonyms: @yield): 记录生成器函数生成的值。

内联标签

@link (synonyms: @linkcode, @linkplain): 链接到文档中的另一个项目。
@tutorial: 教程链接。

当前版本 v4.0