jsdoc配置

1. 安装jsdoc

npm install jsdoc -g

2 新建配置文件 jsdoc.json,该文件里配置运行jsdoc参数设置

{
  "plugins": [
  "plugins/markdown",
  "plugins/summarize"
],
  "recurseDepth": 10,
  "source": {
    "include": [ "build/Autonomy/" ],//设置计划生成doc的目录
    "includePattern": ".+\\.js(doc|x)?$",//设置计划生成doc目录中的文件格式
    "exclude": [ "build/Autonomy/css/" ]//设置不生成doc的目录
  },
  "sourceType": "module",
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc","closure"]
  },
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false,
    "default": {
      "outputSourceFiles": true
    }
  },
  "opts": {
    "template":  "templates/docdash",//样式模版
    "encoding": "utf8",
    "destination": "./docs/",//输出路径
    "recurse": true
  }
}

3. package.json 中设置npm的的运行配置

"scripts": {
     
    "docs": "jsdoc -c jsdoc.json"
  },

4.几种 jsdoc模版安装，安装完成后node_modules中会生成对应的文件夹，将生成模版文件夹复制到jsdoc中的templates文件夹下，修改jsdoc.json中的配置即可。

npm install docdash
npm install  minami
npm i -D tui-jsdoc-template