JSDoc 使用入门
来源:互联网 发布:印度出口数据 编辑:程序博客网 时间:2024/06/06 17:48
JSDoc 使用入门
Java语言引入了一个工具,名为javadoc。这个工具可以根据源代码中的文档注释以HTML格式生成API文档。所生成的HTML文档在任何Web浏览器上都能阅读,而且由于它是以HTML格式生成的,所以可以在线发布,这样开发人员就能很容易地访问这些文档。要以一种可以轻松浏览的格式来提供API文档,这样开发人员就不必仔细地查看源代码才能了解某个类或方法会有怎样的行为,以及该如何使用。
JSDoc则是面向JavaScript的一个类似的工具。JSDoc是一个开源工具,得到了GNU Public License(GPL)的许可。JSDoc用Perl编写,这意味着Windows用户必须先安装一个Perl运行时环境。(而对于大多数Linux和Unix操作系统,Perl都会作为其中的一个标准部分。)
1.
既然Linux下已经安装了Perl,这里就不再赘述如何安装Perl。
2,
安装JSDoc:
在http://code.google.com/p/jsdoc-toolkit/ 下载JSDoc最新版,我的是JsDoc Toolkit version 2.4.0
3.
标记的使用:
4.
生成文档:
java -jar jsrun.jar app/run.js -a -e=GB18030 -t=templates/jsdoc test/*.js
- JSDoc 使用入门
- JSDoc 3 入门
- jsdoc-toolkit高级使用
- jsdoc使用markdown插件
- jsdoc
- jsDoc
- 开源JsDoc的使用介绍
- 使用JSDoc建立JavaScript代码的文档
- LInux下使用JSDoc生成javaScript文档
- 利用jsdoc提高自动提示—Webstorm入门指南
- js编码规范:使用JSDoc建立JavaScript代码的文档
- JsDoc 介绍
- JsDoc Toolkit
- jsDoc使用方法
- ant结合jsdoc构建js文档—ant入门指南(8)
- jsdoc3初次使用的遇到的一个错误:Error: Module jsdoc.js not found.
- 如何注释javascript-jsDoc
- jsdoc for sublime2
- poj 1328 贪心
- Tomcat7.0.22在Windows下详细配置过程
- 十大C++经典教程
- Fedora 14 安装手记
- ubuntu下Android源代码模块编译
- JSDoc 使用入门
- freeswitch内核模块开发
- 初学者必备:C++经典入门详细教程
- [Struts2]访问request,session和application对象
- java编程中出现的几个异常
- 变量命名规则------匈牙利命名规则!
- Perforce命令行设置服务器端、备份及恢复资料库
- Fedora 16 更新源设置(交大、163、sohu)
- 8295A总结