http://usejsdoc.org/index.html
npm install -g jsdoc
https://github.com/Kocal/jsdoc-vuejs
npm install --save-dev jsdoc-vuejs
新建conf.json文件
{
"plugins": [
"node_modules/jsdoc-vuejs"
],
"source": {
"includePattern": "\\.(vue|js)$"
},
"opts": {
"destination": "./doc",
"encoding": "utf8",
"private": true,
"recurse": true,
"template": "node_modules/minami"
}
}
npm install --save-dev minami
jsdoc-vuejs插件新增了以下几个块标签
@vue-prop
@vue-data
@vue-computed
用法和@param一样。
在需要文档的地方,用块标签注释。
像这样:
/**
* @classdesc 按钮
* @vue-prop {String} value - 文本
* @vue-prop {String} [width='265wx'] - 宽度
* @vue-prop {String} [height='35wx'] - 高度
* @vue-prop {String} [fontSize='16wx'] - 文本字号
* @vue-prop {String} [fontColor='#ffffff'] - 文本颜色
* @vue-prop {String} [fontStyle='normal'] - 文本风格,可选normal或blod
* @vue-prop {Boolean} [disable=false] - 是否不可点击
* @vue-prop {String} [srcNormal=默认图片] - 按钮背景图片
* @vue-prop {String} [srcDiable=默认图片] - 按钮不可点击背景图片
*
* @emits clickbtn 点击事件
*/
然后在工程目录下
jsdoc -c ./conf.json ./src/*
完成!
效果是这样的:
扫码关注腾讯云开发者
领取腾讯云代金券
Copyright © 2013 - 2025 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号:粤B2-20090059 深公网安备号 44030502008569
腾讯云计算(北京)有限责任公司 京ICP证150476号 | 京ICP备11018762号 | 京公网安备号11010802020287
Copyright © 2013 - 2025 Tencent Cloud.
All Rights Reserved. 腾讯云 版权所有