jsDoc+docdash生成说明文档

1. 全局安装jsDoc和docdash   

   npm i jsdoc docdash -g

   npm i jsdoc docdash -g

2. 在项目根目录添加名为jsdoc.json的文件，并在文件中添加以下内容

   {
     "recurseDepth": 3, // 递归深度，3级从根目录开始算往下三层 /src/hooks/xxx
     "source": {
       "include": [ "src/"], // jsDoc的扫描目录
       "includePattern": ".+\\.js(doc|x)?$", // 文件类型限制，和上一个include属性取交集
       "exclude": [ "src/libs" ] // 排除掉哪个目录
     },
     "opts": {
       "template": "C:\\Program Files\\nodejs\\node_modules\\docdash", // 使用的样式模板的目录，由于安装在全局，所以请自行匹配node安装位置
       "encoding": "utf8", // 编码格式
       "destination": "./docs/", // 生成的文件夹的名字，类似于dist
       "recurse": true // 是否递归子目录
     },
     "docdash": {
       "search": true, // docdash的搜索功能
       "navLevel": 2, // 在导航栏中显示的深度级别
       "collapse": true,// 是否可折叠
       "verbose": true // 是否输出详细信息
     }
   }

3. 在package.json内的scripts属性里添加下面内容  

   "docs": "jsdoc -c jsdoc.json"

4. npm run docs 

6. 

7. 添加jsconfig.json

{
  "compilerOptions": {
    "baseUrl": "./",
    "paths": {
      "@/*": ["./src/*"]
    }
  },
  "exclude": ["node_modules", "dist"]
}