索引

入门

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

JSDoc 示例

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

块级标签

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

内联标签

@link（同义词：@linkcode、@linkplain）: 链接到文档中的另一项。
@tutorial: 链接到教程。

贡献

GitHub 上的 JSDoc 项目: 为 JSDoc 做出贡献。
GitHub 上的 JSDoc 文档项目: 为 JSDoc 文档做出贡献。

在 GitHub 上关注我