jsdoc-vue-component

A simple plugin for jsdoc (pase vue SFC info to description by AST analysis).

注意

只解析vue组件中的module.exports = {} 和 export default {}

Installation

1npm i jsdoc-vue-component -D

Related

• espree: parse code to ast.
• escodegen: generate code from ast.
• estraverse: traverse the AST tree.
• JsDoc3.
• docstrap: a theme for jsdoc3.
• jsdoc-vuedoc: A jsdoc3 plugin use @vuedoc/md.

Use:

This plugin just extract the component's info into markdown format, and instert it into the @vuedoc's position.

Not affect other jsdoc features of the code.

1. add @vuedoc tag to comment.
2. add @exports componentName tag to comment.

just add @vuedoc tag, @exports tag, to the to document in you vue SFC.

1/**
2 * sidebar component description
3 * @vuedoc
4 * @exports component/SideBar
5 */
6export default {}

如何使用jsdoc？

• 安装jsdoc: npm i jsdoc -D
• 安装模板：npm i sherry-docstrap -D, 原来的docstrap有点小bug还未修复，所以自己暂时发布一个。
• 在项目目录下建了配置文件：下面有示例，适当修改。
• 在pacakge.json 里添加一个script: "jsdoc": "rm -rf public/jsdoc && node_modules/.bin/jsdoc -c jsdoc.json", public/jsdoc为发布位置，适当修改
• 生成文档: npm run jsdoc

Options

• log: true,
• tag: 'vuedoc'

jsdoc.json

1{
2  "plugins": [
3    "node_modules/jsdoc-vue-component",
4    "plugins/markdown",
5    "plugins/summarize"
6  ],
7  "jsdoc-vue-component": {
8    "log": true
9  },
10  "markdown": {
11    "tags": ["author", "classdesc", "description", "param", "property", "returns", "see", "throws", "vue"]
12  },
13  "recurseDepth": 10,
14  "source": {
15    "include": ["fe/src"],
16    "includePattern": ".+\\.(js|vue)$",
17    "excludePattern": "(^|\\/|\\\\)_"
18  },
19  "sourceType": "module",
20  "tags": {
21    "allowUnknownTags": true,
22    "dictionaries": ["jsdoc", "closure"]
23  },
24  "templates": {
25    "logoFile": "",
26    "cleverLinks": false,
27    "monospaceLinks": false,
28    "dateFormat": "ddd MMM Do YYYY",
29    "outputSourceFiles": true,
30    "outputSourcePath": true,
31    "systemName": "DocStrap",
32    "footer": "",
33    "copyright": "DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.",
34    "navType": "vertical",
35    "theme": "cosmo",
36    "linenums": true,
37    "collapseSymbols": false,
38    "inverseNav": true,
39    "protocol": "html://",
40    "methodHeadingReturns": false
41  },
42  "markdown": {
43    "parser": "gfm",
44    "hardwrap": true
45  },
46  "opts": {
47    "template": "node_modules/sherry-docstrap/template",
48    "encoding": "utf8",
49    "destination": "./public/jsdoc/",
50    "recurse": true,
51    "readme": "README.md",
52    "tutorials": "./docs/"
53  }
54}

效果

.