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（生成文件模板）