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