开始使用
- 开始使用 JSDoc 3
- 使用JSDoc为JavaScript生成文档的快速指南
- JSDoc 3中的名称路径
- JSDoc 3中的名称路径的指南
- JSDoc中的命令行参数
- 关于JSDoc中的命令行参数.
- 使用配置文件配置JSDoc
- 展示如何使用配置文件配置JSDoc。
- 配置 JSDoc 的默认模板
- 在JSDoc的默认模板中如何配置输出。
- 块标签和内联标签
- 块标签和内联标签概述
- 关于JSDoc插件
- 如何创建并使用JSDoc插件.
- 使用 Markdown 插件
- 开启 Markdown 插件支持
- Tutorials
- 给你的API文档中添加教程
- 包含Package文件
- 如何在文档中显示包信息。
- 包含 README 文件
- 如何将README文件包含进文档。
- License
- License information for JSDoc 3.
JSDoc示例
- ES 2015 Classes
- 如何给ECMAScript 2015 classes添加JSDoc注释.
- ES 2015 Modules
- 如何给ECMAScript 2015 modules添加JSDoc注释。
- 添加CommonJS 模块
- 如何给CommonJS 和 Node.js 模块添加JSDoc注释.
- 添加AMD Modules
- 如何给AMD和RequireJS模块添加JSDoc注释
- JSDoc @abstract 标签 (同义词: JSDoc @virtual 标签)
- 描述这个成员必须在继承的子类中实现（或重写）。
- JSDoc @access 标签
- 指定该成员的访问级别（私有 private，公共 public，或保护 protected）。
- JSDoc @alias 标签
- 标记成员有一个别名。
- JSDoc @async 标签
- Indicate that a function is asynchronous.
- JSDoc @augments 标签 (同义词: JSDoc @extends 标签)
- 指名这个子类继承至哪个父类，后面需要加父类名。
- JSDoc @author 标签
- 指定项目的作者。
- JSDoc @borrows 标签
- 指明这个对象使用另一个对象的某些东西。
- JSDoc @callback 标签
- 描述一个回调函数。
- JSDoc @class 标签 (同义词: JSDoc @constructor 标签)
- 此函数旨在需要使用"new"关键字调用，即构造函数。
- JSDoc @classdesc 标签
- 用于为类提供一个描述，这样和构造函数的描述区分开来.
- JSDoc @constant 标签 (同义词: JSDoc @const 标签)
- 指明这个对象是一个常量。
- JSDoc @constructs 标签
- 描述这个函数成员将成为类的构造函数。
- JSDoc @copyright 标签
- 描述一个文件的版权信息。
- JSDoc @default 标签 (同义词: JSDoc @defaultvalue 标签)
- 描述默认值.
- JSDoc @deprecated 标签
- 标签指明一个标识在你代码中已经被弃用。
- JSDoc @description 标签 (同义词: JSDoc @desc 标签)
- 描述一个标识符。
- JSDoc @enum 标签
- 描述一个相关属性的集合。
- JSDoc @event 标签
- 描述一个事件。
- JSDoc @example 标签
- 提供一个如何使用描述项的例子。
- JSDoc @exports 标签
- 标识一个由JavaScript模块导出的成员。
- JSDoc @external 标签 (同义词: JSDoc @host 标签)
- 用来标识一个在当前包外部定义的类，命名空间，或模块。
- JSDoc @file 标签 (同义词: JSDoc @fileoverview 标签, JSDoc @overview 标签)
- 描述一个文件。
- JSDoc @fires 标签 (同义词: JSDoc @emits 标签)
- 描述事件这个方法可能会触发。
- JSDoc @function 标签 (同义词: JSDoc @func 标签, JSDoc @method 标签)
- 描述一个函数或方法。
- JSDoc @generator 标签
- Indicate that a function is a generator function.
- JSDoc @global 标签
- 指定一个在文档的标识是为全局性的标识。
- JSDoc @hideconstructor 标签
- Indicate that the constructor should not be displayed.
- JSDoc @ignore 标签
- 忽略文档中的一个标识。
- JSDoc @implements 标签
- 指示一个标识实现一个接口
- JSDoc @inheritdoc 标签
- 指明这个标识应继承其父类的文档。
- JSDoc @inner 标签
- 描述一个内部对象。
- JSDoc @instance 标签
- 标明该标识符作为它父标识符的实例成员。
- JSDoc @interface 标签
- 使一个标识符作为其他标识符的一个实现接口。
- JSDoc @kind 标签
- 指明标识的类型
- JSDoc @lends 标签
- 将一个字面量对象的所有属性标记为某个标识符（类或模块）的成员。
- JSDoc @license 标签
- 标识你的代码采用何种软件许可协议。
- JSDoc @listens 标签
- 指示一个标识监听指定的事件。
- JSDoc @member 标签 (同义词: JSDoc @var 标签)
- 记录一个成员。
- JSDoc @memberof 标签
- 标明这个标识属于哪个父级标识。
- JSDoc @mixes 标签
- 此对象混入了另一个对象中的所有成员。
- JSDoc @mixin 标签
- 记录一个mixin（混入）对象。
- JSDoc @module 标签
- 记录一个 JavaScript 模块。
- JSDoc @name 标签
- 记录一个对象的名称。
- JSDoc @namespace 标签
- 记录一个命名空间对象。
- JSDoc @override 标签
- 指明一个标识符覆盖其父类同名的标识符。
- JSDoc @package 标签
- This symbol is meant to be package-private.
- JSDoc @param 标签 (同义词: JSDoc @arg 标签, JSDoc @argument 标签)
- 记录传递给一个函数的参数。
- JSDoc @private 标签
- 标记标识符为私有。
- JSDoc @property 标签 (同义词: JSDoc @prop 标签)
- 记录一个对象的属性。
- JSDoc @protected 标签
- 标记标识符为受保护的。
- JSDoc @public 标签
- 标记为公开的。
- JSDoc @readonly 标签
- 标记一个标识符为只读。
- JSDoc @requires 标签
- 指示这个文件需要一个 JavaScript 模块。
- JSDoc @returns 标签 (同义词: JSDoc @return 标签)
- 描述一个函数的返回值。
- JSDoc @see 标签
- 指明可以参考另一个标识符的说明文档，或者一个外部资源。
- JSDoc @since 标签
- 标签标明一个类，方法，或其它标识符是在哪个特定版本开始添加进来的。
- JSDoc @static 标签
- 记录一个静态成员。
- JSDoc @summary 标签
- 完整描述的一个简写版本。
- JSDoc @this 标签
- 指明this关键字的指向
- JSDoc @throws 标签 (同义词: JSDoc @exception 标签)
- 说明可能会被抛出什么样的错误.
- JSDoc @todo 标签
- 记录要完成的任务。
- JSDoc @tutorial 标签
- 插入一个到包含教程文件的链接。
- JSDoc @type 标签
- 记录一个对象的类型。
- JSDoc @typedef 标签
- 描述自定义类型.
- JSDoc @variation 标签
- 区分具有相同名称的不同的对象。
- JSDoc @version 标签
- 指明被用于表示该项的版本。
- JSDoc @yields 标签 (同义词: JSDoc @yield 标签)
- Document the value yielded by a generator function.
- JSDoc {@link} (同义词: JSDoc {@linkcode}, JSDoc {@linkplain})
- 链接到文档中的其他项。
- JSDoc {@tutorial}
- 链接到一份教程。