js-doc
渔倒到
返璞归真(人-> 猿)
展开
-
vuecli + js-doc 生成漂亮的说明文档
维护代码 重要的是有文档,js-doc 在线生成文档 是一个很好的选择 依赖 “vue-template-compiler”: “^2.6.11”, “minami”: “^1.2.3”, js-doc 6.9.0 根目录下创建 .jsdoc.conf.json 内容 { "tags": { "allowUnknownTags": true, // 指定所用词典 "dictionaries": [ "jsdoc" ] },原创 2020-12-29 15:55:17 · 1163 阅读 · 7 评论 -
js-doc 常用书写格式
接上篇 js-doc集成vuecli 传送门 已经在vue项目中安装了 js-doc 接下来就是按照规范书写注释代码来生成文档 先来个图吧 首先组件说明 /** * 自定义下拉选择区间组件 * @module 组件名 * @author *** * @description 组件描述 * */ props 说名 /** * Props 说明 * @prop {type} 参数名称 注释内容 */ 类似的 计算属性 组件引用等一致的 方法说明 /** * 解释 *原创 2020-12-31 16:27:16 · 435 阅读 · 0 评论