需要在每个项目的静态资源构建的时,生成对应的注释文档,所以用到jsdoc自定义配置文件,方便查询总结此篇。
一、配置文件,文件名称可自定义,我的叫jsdoc.json;代码如下:
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc","closure"]
},
"source": {
"include": ["source/js"],
"exclude": [],
"includePattern": ".+\\.js(doc)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"plugins": [],
"templates": {
"cleverLinks": false,
"monospaceLinks": false
}
}
1、source.include:需要生成注释文档的文件,数组形式
2、source.includePattern:文件名称符合此正则表达式的文件才生成注释文档。
注:其他属性暂时用不到,后续补充。
二、执行jsdoc.json文件
前提:全局安装过jsdoc
命令如下:
jsdoc -d outFileName -c jsdoc.json -r
参数说明:
1、-d 指定注释文档输出路径
2、-c 告诉jsdoc自定义配置文件的位置
3、-r 告诉jsdoc循环source.include文件夹的子目录
目前用到的就是这些,jsdoc比记录的这些强大的太多,挑用到的记录下来,方便查询。