npm i jsdoc -g

如何使用JSDoc

同其他语言一样，文档生成工具的原理还是通过代码注释去解析并根据一定的tag来生成文档。在JSDoc文档中明确说明了，只有以/**为开始的注释才会被JSDoc识别，其他的注释格式都会被忽略。

额外，JSDoc 默认还会将项目中的README.md文件一同生成到JSDoc最后生成的文档文件中，或通过命令--R/-readme 指定个别文件，将其添加至所生成的文档文件中，但文件格式必须是Markdown，此时，项目中的README.md将被忽略。

JSDoc命令行参数

JSDoc命令行几个常用参数有以下几个：

• -c, --configure 指定configuration file
• -d, --destination 指定输出路径，默认./out
• -e, --encoding 设定encoding，默认utf8
• -p, --private 将private注释输出到文档，默认不输出
• -P, --package 指定package.json file
• -r, --recurse 查询子目录
• -t, --template 指定输出文档template
• -u, --tutorials 指定教程路径，默认无

JSDoc配置文件

同许多js工具一样，JSDoc也有配置文件，可以通过设定配置文件来定制JSDoc。如果没有指定configuration file，将会使用一下配置。

{
    "tags": {
        "allowUnknownTags": true, // 允许使用自定义tag
        "dictionaries": ["jsdoc","closure"] // 定义tag集
    },
    "source": {
        "includePattern": ".+\\.js(doc)?$", // 将以.js, .jsdoc结尾的文件作为源文件
        "excludePattern": "(^|\\/|\\\\)_" // 忽略以_开头的文件夹及文件
    },
    "plugins": [],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    }
}