vue项目 jsdoc自动生成文档配置

jsdoc文档地址

jsdoc.conf.json，放在根目录下

{  "tags": {    "allowUnknownTags": true,    "dictionaries": ["jsdoc", "closure"]  },  "recurseDepth": 10,  "source": {    "include": ["./src"],    "includePattern": ".+\\.(vue)$",    "excludePattern": "(^|\\/|\\\\)_"  },  "plugins": ["./jsdoc-vue"],  "templates": {    "cleverLinks": false,    "monospaceLinks": true,    "useLongnameInNav": false,    "showInheritedInNav": true  },  "opts": {    "destination": "./doc",    "encoding": "utf8",    "private": true,    "recurse": true,    "template": "./node_modules/minami"  }}

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 : '';    }  },};

.vue文件中的注释：

/** @author loading * @type {string} * default false */ loading: false,

在当前目录下执行命令：jsdoc -c .jsdoc.conf.json

生成的文件目录在jsdoc.conf.json中opts配置的destination目录下（此例为doc）

目录好像有点不太对，下次再研究下。以上并没什么用，只是做个笔记。