jsDoc 使用及配置!


jsDoc 說白了就是幫助你生成JS的文檔,但有個前提,就是你編寫的JS代碼中,需要按一定的格式寫注釋后,這個工具軟件才能幫你正確的生成文檔!

一、配置使用環境。此軟件是 JAVA寫的,所以我們要在windows 系統中配置java的環境變量

1、下載jdk(http://java.sun.com/javase/downloads/index.jsp),我下載的版本是:jdk-6u14-windows-i586.exe

2、安裝jdk-6u14-windows-i586.exe

3、配置環境變量:右擊“我的電腦”-->"高級"-->"環境變量"

1)在系統變量里新建JAVA_HOME變量,變量值為:C:\Program Files\Java\jdk1.6.0_14(根據自己的安裝路徑填寫)

2)新建classpath變量,變量值為:.;%JAVA_HOME%\lib;%JAVA_HOME%\lib\tools.jar

3)在path變量(已存在不用新建)添加變量值:%JAVA_HOME%\bin;%JAVA_HOME%\jre\bin(注意變量值之間用“;”隔開)

4、“開始”-->“運行”-->輸入“javac”-->"Enter",如果能正常打印用法說明配置成功!

補充環境變量的解析:

JAVA_HOME:jdk的安裝路徑

classpath:java加載類路徑,只有類在classpath中java命令才能識別,在路徑前加了個"."表示當前路徑。

path:系統在任何路徑下都可以識別java,javac命令。

 

二、下載 jsdoc_toolkit ,並解壓

三、這里我們需要通過命令行進行創建javascript文檔。 

java -jar jsrun.jar app/run.js -a -e=GB18030 -t=templates/jsdoc test/*.js 

當然如果感覺通過命令行的方式比較麻煩,我們可以自行創建一個.bat文件
將上面的內容復制到該文件中,執行即可。
下面我來簡單解釋一下這其中的參數
-a 表示全部的方法
-e 表示對應的文件的編碼根式 這里對應的是GB18030 默認的是utf-8
-t 表示生產doc的文檔樣式模板
這里的test/*.js表示在test目錄下的全部javascript文件
執行完畢后將文檔結果默認輸出到/out/jsdoc目錄下。

jsrun.jar app/run.js 可以使用的參數,可以在CMD中輸入如下命令進行查看
java -jar jsrun.jar app/run.js --help

 

四、命令名規范

命 令 名 描  述 
@param  @argument 指定參數名和說明來描述一個函數參數 
@returns         描述函數的返回值 
@author          指示代碼的作者 
@deprecated    指示一個函數已經廢棄,而且在將來的代碼版本中將徹底刪除。要避免使用這段代碼 
@see               創建一個HTML鏈接,指向指定類的描述 
@version         指定發布版本 
@requires        創建一個HTML鏈接,指向這個類所需的指定類 
@throws @exception   描述函數可能拋出的異常的類型 
{@link}           創建一個HTML鏈接,指向指定的類。這與@see很類似,但{@link}能嵌在注釋文本中 
@fileoverview   這是一個特殊的標記。如果在文件的第一個文檔塊中使用這個標記,則指定該文檔塊的余下部分將用來提供這個文件的概述 
@class            提供類的有關信息,用在構造函數的文檔中 
@constructor   明確一個函數是某個類的構造函數 
@type            指定函數的返回類型 
@extends       指示一個類派生了另一個類。JSDoc通常自己就可以檢測出這種信息,不過,在某些情況下則必須使用這個標記 
@private         指示一個類或函數是私有的。私有類和函數不會出現在HTML文檔中,除非運行JSDoc時提供了--private命令行選項 
@final             指示一個值是常量值。要記住JavaScript無法真正保證一個值是常量 
@ignore         JSDoc忽略有這個標記的函數

 

五 、注釋以/**開頭,以*/結束,關鍵字以@開頭

參考網站:http://usejsdoc.org
http://www.36ria.com/5101


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM