JSDoc 使用入门

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