JSDoc 中文文档
介绍
1.
入门（Getting Started）
1.1.
JSDoc 3中使用名称路径
1.2.
JSDoc中的命令行参数
1.3.
用conf.json配置JSDoc
1.4.
配置JSDoc的默认模板
1.5.
块标签和内联标签
1.6.
关于JSDoc插件
1.7.
使用Markdown插件
1.8.
Tutorials 教程
1.9.
包含Package（包）文件
1.10.
包含 README 文件
2.
JSDoc 示例
2.1.
ES 2015 Classes(类)
2.2.
ES 2015 Modules（模块）
2.3.
CommonJS Modules（模块）
2.4.
AMD Modules（模块）
3.
块标签（Block Tags）
3.1.
@abstract
3.2.
@access
3.3.
@alias
3.4.
@augments
3.5.
@author
3.6.
@borrows
3.7.
@callback
3.8.
@class
3.9.
@classdesc
3.10.
@constant
3.11.
@constructs
3.12.
@copyright
3.13.
@default
3.14.
@deprecated
3.15.
@description
3.16.
@enum
3.17.
@event
3.18.
@example
3.19.
@exports
3.20.
@external
3.21.
@file
3.22.
@fires
3.23.
@function
3.24.
@global
3.25.
@ignore
3.26.
@implements
3.27.
@inheritdoc
3.28.
@inner
3.29.
@instance
3.30.
@interface
3.31.
@kind
3.32.
@lends
3.33.
@license
3.34.
@listens
3.35.
@member
3.36.
@memberof
3.37.
@mixes
3.38.
@mixin
3.39.
@module
3.40.
@name
3.41.
@namespace
3.42.
@override
3.43.
@param
3.44.
@private
3.45.
@property
3.46.
@protected
3.47.
@public
3.48.
@readonly
3.49.
@requires
3.50.
@returns
3.51.
@see
3.52.
@since
3.53.
@static
3.54.
@summary
3.55.
@this
3.56.
@throws
3.57.
@todo
3.58.
@tutorial
3.59.
@type
3.60.
@typedef
3.61.
@variation
3.62.
@version
4.
内联标签（Inline Tags）
4.1.
@link
4.2.
@tutorial
本书使用 GitBook 发布
JSDoc 介绍
内联标签（Inline Tags）
标签名
别名
描述
@link
@linkcode 或 @linkplain
链接到文档中的另一个项目。
@tutorial
链接到一个教程