十分推荐,编辑代码的时候有写注释的习惯,后期直接自动生成文档,不用劳神费力的一点找一点写。 前期工作还是配置环境, 下载JDK 配置变量等等就不提了, 我是用的grunt软件来配合项目使用的 , 压缩 编译 格式化 文档自动化 , 很方便。 想要在项目里面支持grunt-jsdoc其实很简单。因为本身grunt就是一个基于Node.js的软件,其插件也是通过npm进行维护的,那么我们安装jsdoc其实很方便,就一行代码。
1 | npm install grunt-jsdoc --save-dev |
下载完成之后就是配置 grunt-jsdoc的问题,其实很简单,配置如下:
1 | grunt.initConfig({jsdoc :{ dist : { src: [ |