使用jsdoc-toolkit实现JS API文档自动化
2014-11-11 17:13
405 查看
在前面的博文中探讨自动化工程问题时,写过基于NodeJS的,使用gulp、grunt的jsdoc插件实现文档自动化。本文探讨基于java环境的自动化实现。
-> cmd -> 命令行窗口
-> cd到jsdoc-toolkit所在目录(我的是G:\Workspace\jsdoc-toolkit)
-> windows:java -jar jsrun.jar app\run.js -a -t=templates\jsdoc myTest/myTest.js
Linux:$ java -jar jsrun.jar app/run.js -a -t=templates/jsdoc myTest/myTest.js
-> 运行后生成out(默认)目录
-> 完成自动化API文档。
当然myTest.js文件中的注释需要符合jsDoc规范。 如果我们不想使用默认目录out,可以通过-d命令来设置。
jsdoc-toolkit相关命令参考:
转载声明:
本文标题:使用jsdoc-toolkit实现JS API文档自动化
本文链接:http://www.zuojj.com/archives/1064.html,转载请注明转自Benjamin-专注前端开发和用户体验
一、Java安装与环境配置
关于Java的安装与环境配置,可以参考博文YUI Compressor for Sublime text2二、jsdoc-tookit下载与使用
下载链接:jsdoc-tookit,现在地址可能被墙了,可以通过搜索其它渠道下载。下面完成后,解压到工作目录即可。-> cmd -> 命令行窗口
-> cd到jsdoc-toolkit所在目录(我的是G:\Workspace\jsdoc-toolkit)
-> windows:java -jar jsrun.jar app\run.js -a -t=templates\jsdoc myTest/myTest.js
Linux:$ java -jar jsrun.jar app/run.js -a -t=templates/jsdoc myTest/myTest.js
-> 运行后生成out(默认)目录
-> 完成自动化API文档。
当然myTest.js文件中的注释需要符合jsDoc规范。 如果我们不想使用默认目录out,可以通过-d命令来设置。
jsdoc-toolkit相关命令参考:
转载声明:
本文标题:使用jsdoc-toolkit实现JS API文档自动化
本文链接:http://www.zuojj.com/archives/1064.html,转载请注明转自Benjamin-专注前端开发和用户体验
相关文章推荐
- 使用jsdoc-toolkit来自动生成js api文档
- 使用jsdoc-toolkit来自动生成js api文档
- 使用swagger实现在线api文档自动生成 在线测试api接口
- jsdoc-toolkit文档工具使用说明
- android和JS交互,相互调用方法传值。不使用第三方实现原生加载word、ppt、pdf文档
- Vue.js——使用$.ajax和vue-resource实现OAuth的注册、登录、注销和API调用
- jsdoc利用模板生成js API文档
- node.js中使用q.js实现api的promise化
- 使用Swagger实现webapi接口自动化文档生成
- 使用Swagger2Markup实现API文档的静态部署(一)
- 使用node.js进行API自动化回归测试
- vue.js学习07之使用$.ajax和vue-resource实现OAuth的注册、登录、注销和API调用
- 使用js实现页面导出到word文档
- WCF中使用Swagger框架实现接口文档自动化
- 使用Swagger2Markup实现API文档的静态部署(二):Markdown和Confluence
- Javascript自动化文档工具JSDuck在Windows下的使用心得
- 08、一步一步学thinkjs之实现提供一个 API 供第三方使用
- jsdoc注释规范工具(使用 JSDoc 3 自动生成 JavaScript API 文档)
- angularjs ngdocs 使用grunt生成api文档说明
- 使用Swagger2Markup实现API文档的静态部署(一):AsciiDoc