收先必要工具
1.首先點選project -> Generate JavaDoc
2.接下來會跳出這個視窗
3. 首先先設定Javadoc command 把他指定到你的JDK底下的bin裡面的javadoc.exe (DOC是利用這個執行檔產生出來的)
然後選擇你要產生的JAVA檔,這邊通常都直接把src打勾勾就好,因為src通常底下才是你寫的程式
下面有個Distination 指定你輸出目錄
好了 按 NEXT
4.這便預設就好 按 NEXT
5.這邊中間有個要注意的地方, 如果你是用UTF8編碼,請加上以下字串如圖上所示,要不然預設是MS950
-charset UTF-8 -encoding UTF-8
按 FINISH 就結束嚕,你就可以在你輸出目錄看到你產生的DOC,直接開啟index.html就可以看了
javadoc的註釋
javadoc的註釋方式已經忘得差不多,需要複習一下。
不錯的參考網頁
參考:http://mobile.tutsplus.com/tutorials/android/javadoc/
- Eclipse
- JDK
1.首先點選project -> Generate JavaDoc
2.接下來會跳出這個視窗
3. 首先先設定Javadoc command 把他指定到你的JDK底下的bin裡面的javadoc.exe (DOC是利用這個執行檔產生出來的)
然後選擇你要產生的JAVA檔,這邊通常都直接把src打勾勾就好,因為src通常底下才是你寫的程式
下面有個Distination 指定你輸出目錄
好了 按 NEXT
4.這便預設就好 按 NEXT
5.這邊中間有個要注意的地方, 如果你是用UTF8編碼,請加上以下字串如圖上所示,要不然預設是MS950
-charset UTF-8 -encoding UTF-8
按 FINISH 就結束嚕,你就可以在你輸出目錄看到你產生的DOC,直接開啟index.html就可以看了
javadoc的註釋
javadoc的註釋方式已經忘得差不多,需要複習一下。
/** ...... */ 註釋若干行,並寫入 javadoc 文檔,命令行為:javadoc -d 文檔存放目錄 -author -version 源文件名.java,在Eclipse中Porject-> Generate Javadoc...
在/** */裡面是可以使用HTML的腳本,例如<li>,<br>等等。可以在類,方法之前加入註釋說明。例子如下:
/**
* 方法/類的簡述.
* <p>詳細說明第一行<br>
* 詳細說明第二行
* @param ,用於參數描述
* @return ,描述返回之沒有返回值
*/
@author 標明開發該類模塊的作者
@version 標明該類模塊的版本
@see 參考轉向,也就是相關主題
@param 對方法中某參數的說明
@return 對方法返回值的說明
@exception 對方法可能拋出的異常進行說明
@author 作者名
@version 版本號
Simple Javadoc Field Comments
Simple Javadoc Method Comments
不錯的參考網頁
參考:http://mobile.tutsplus.com/tutorials/android/javadoc/
沒有留言:
張貼留言