1.利用npm安装jsdoc模块
npm install jsdoc -g
2.由于jsdoc默认的生成文档模板不好看,可以下载一套好看些的模板,如 jaguar.js
也可用npm下载
3.将node_modules/jsdoc/templates/default下面的内容删除掉,然后将第二步下载的全部内容放在里面
4.创建jsdoc的配置文件
建立一个conf.json
{
"tags": {
"allowUnknownTags": true
},
"source": {
"include": ["lib"],
"includePattern": ".+\\.js(doc)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"templates": {
"cleverLinks": true,
"monospaceLinks": true,
"default": {
"outputSourceFiles" : true
},
"applicationName": "demo",
"openGraph": {},
"meta": {}
}
}
保存在根目录下。
5.cmd下输入 jsdoc -c conf.json,生成的out文件夹就是文档生成的位置。