自动生成文档-jsDoc

快速入门

# 编写注释
/**
 * Represents a book.
 * @constructor
 */
function Book(title, author) {
}
# 生成文档
jsdoc book.js

编写注释

# 描述

# 标签
/** @constructor */

# 路径
Person#say  // the instance method named "say."
Person.say  // the static method named "say."
Person~say  // the inner method named "say."

生成文档

# 参数

配置文件

# 文件格式

# 默认选项

# 使用插件

# 遍历深度

# 指定输入

# 源码类型

# 标签控制

# 配置模板

配置模板

块级标签

行内标签

使用插件

创建

使用

使用指南

http://usejsdoc.org