Vue项目 *.js 使用 jsdoc 生成 JavaScript 文档

一、安装 jsdoc

npm install --save-dev jsdoc

二、配置 jsdoc.json

{"source": {"include": [ "src/" ],"exclude": [ "src/router" ]},"opts": {"template": "node_modules/docdash","encoding": "utf8","destination": "./docs/","recurse": true,"verbose": true}
}

配置项

source

source.include JSDOC 需要扫描哪些文件

source.exclude JSDOC 需要排除哪些文件

opts

opts.template   生成文档的模板，默认是 templates/default

opts.encoding   读取文件的编码，默认是 utf8

opts.destination  生成文档的路径，默认是 ./out/

opts.recurse 运行时是否递归子目录

opts.verbose 运行时是否输出详细信息，默认是 false

三、配置 package.json 的 scripts

"scripts": {"dev": "vue-cli-service serve","build": "vue-cli-service build","build:doc": "jsdoc -c ./jsdoc.json",
},

四、JavaScript 文件使用 /** 注释

/*** 解析日期时间到时间戳* @param date {Date} 日期时间* @param digits {Boolean} 是否是10位时间戳* @returns {number}*/
export function dateParseTime(date, digits = true) {return digits ? Date.parse(new Date(date)) / 1000 : Date.parse(new Date(date));
}

五、npm run build:doc 生成 JavaScript 文档

六、更多请查看文档

/*** @author LiuDanyang* @class* @name 登录* @description 登录类* @param {String} 用户名* @param {String} 密码* @return {Login}** @example* // 创建登录* new Login(user, pass);*/
export default class Login {/*** @private* @function* @name 初始化* @description 初始化登录*/init() {}
}

参考资料：

JSDoc中文文档、JSDoc官网、Github jsdoc

Vue项目 *.js 使用 jsdoc 生成 JavaScript 文档相关推荐

如何快速生成JavaScript文档
JSDoc Template 记得有大神说过,尽量不要注释,除了JsDoc.JsDoc 可以帮助我们通过 JsDoc 的注释风格快速生成 Api 文档.比如 lodash 文档. JsDoc 可以让开 ...
Java Web项目中使用Freemarker生成Word文档
Web项目中生成Word文档的操作屡见不鲜,基于Java的解决方案也是很多的,包括使用Jacob.Apache POI.Java2Word.iText等各种方式,其实在从Office 2003开始,就 ...
Java项目中使用Freemarker生成Word文档
Web项目中生成Word文档的操作屡见不鲜,基于Java的解决方案也是很多的,包括使用Jacob.Apache POI.Java2Word.iText等各种方式,其实在从Office 2003开始,就 ...
java web 操作word文档_Java Web项目中使用Freemarker生成Word文档
Web项目中生成Word文档的操作屡见不鲜.基于Java的解决方式也是非常多的,包含使用Jacob.Apache POI.Java2Word.iText等各种方式,事实上在从Office 2003開始 ...
vue项目中将页面生成图片或者PDF文档
vue中页面快速导出成图片或者PDF文档实现效果图image 实现代码将页面html转换成图片或者PDF文档在需要导出的页面引入在util文件夹下创建htmlToPdf.js文件在main. ...
将HTML导出生成word文档
前言: 项目开发中遇到了需要将HTML页面的内容导出为一个word文档,所以有了这边随笔. 当然,项目开发又时间有点紧迫,第一时间想到的是用插件,所以百度了下.下面就介绍两个导出word文档的方法. ...
Java通过freemarker生成word文档
文档生成目录摘要项目预期效果使用freemaker生成word文档并下载一:导入所需要的maven依赖二:根据word文档生成我们需要的ftl模板文件三:将word需要的数据存入一个map ...
[摘]用Java生成Word文档
开发中隔三叉五的就要用到Word,经常被搞得不胜其烦,不过这次找到了不少好例子,干脆将他们都摘了过来,内容如下: 1. poi是apache的一个项目,不过就算用poi你可能都觉得很烦,不过不要紧,这 ...
java pdf 首行缩进_java使用iText生成pdf文档的对齐方式
一.前言在企业的信息系统中,报表处理一直占比较重要的作用,本文将介绍一种生成PDF报表的Java组件--iText.通过在服务器端使用Jsp或JavaBean生成PDF报表,客户端采用超级连接显示或 ...

Vue项目 *.js 使用 jsdoc 生成 JavaScript 文档

一、安装 jsdoc

二、配置 jsdoc.json

三、配置 package.json 的 scripts

四、JavaScript 文件使用 /** 注释

五、npm run build:doc 生成 JavaScript 文档

六、更多请查看文档

Vue项目 *.js 使用 jsdoc 生成 JavaScript 文档相关推荐

最新文章

热门文章

Vue项目 *.js 使用 jsdoc 生成 JavaScript 文档

一、安装 jsdoc

二、配置 jsdoc.json

三、配置 package.json 的 scripts

四、JavaScript 文件 使用 /** 注释

五、npm run build:doc 生成 JavaScript 文档

六、更多请查看文档

Vue项目 *.js 使用 jsdoc 生成 JavaScript 文档相关推荐

最新文章

热门文章

四、JavaScript 文件使用 /** 注释