vue项目配置jsdoc

一、项目根目录添加jsdoc-vue.js

var compiler = require('vue-template-compiler');

exports.handlers = {
  // 利用 vue-template-compiler 编译 vue 模板
  beforeParse: function (e) {
    if (/\.vue$/.test(e.filename)) {
      var output = compiler.parseComponent(e.source);

      e.source = output.script ? output.script.content : '';
    }
  }
};
复制代码

二、根目录添加.jsdoc.conf.json，其余配置请参考jsdoc在线中文手册

{
    "tags": {
      "allowUnknownTags": true,
      // 指定所用词典
      "dictionaries": [
        "jsdoc"
      ]
    },
    // 查找文件的深度 须要用 -r 参数
    "recurseDepth": 10,
    "source": {
      "include": [
        // 须要编译的文件路径 使用时请替换
        "./src/packages"
      ],
      "includePattern": ".+\\.(vue)$",
      "excludePattern": "(^|\\/|\\\\)_"
    },
    // 使用插件
    "plugins": [
      // 插件路径
      "./jsdoc-vue"
    ],
    "templates": {
      "cleverLinks": false,
      "monospaceLinks": true,
      "useLongnameInNav": false,
      "showInheritedInNav": true
    },
    "opts": {
      // 文档输出路径
      "destination": "./static/doc",
      "encoding": "utf8",
      "private": true,
      "recurse": true,
      // 使用模板 minami
      "template": "./node_modules/minami"
    }
}
复制代码

三、在package.json 添加命令

"doc": "jsdoc -r -c .jsdoc.conf.json"
复制代码

四、依赖插件

jsdoc

vue-template-compiler

minami（生成文件模板）