|
對於Java開發人員來說,很習慣使用JavaDoc文件,JSDoc 是個類似JavaDoc的文件編輯程式,可以建立類似JavaDoc的JavaScript文件。 JSDoc是使用Perl所撰寫而成,這在Linux當中是預設安裝的,如果是Windows的使用者,必須安裝Perl執行環境,例如安裝 ActivePerl。 有了Perl環境之後,您要安裝一個非標準的Perl模組HTML::Template,這可以至 CPAN 尋找,如果您安裝了ActivePerl,則可以使用它的Perl Package Manager,切換至View all packages,並使用過濾器尋找HTML-Template… ![]() 接下來請 下載 JSDoc,並將之解壓縮,然後您可以開啟文字模式,至JSDoc的目錄中,執行以下的指令:
test.js是個範例檔案,當中包括了JSDoc的文件標籤,產生的文件預設會放在js_docs_out目錄中,如果您想指定文件的產生位置,則可以使用-d引數,例如:
下圖為JSDoc由test.js中所產生的文件… |