Login  |  繁體中文
感謝您對「自由軟體鑄造場」的支持與愛護，十多年來「自由軟體鑄造場」受中央研究院支持，並在資訊科學研究所以及資訊科技創新研究中心執行，現已完成階段性的任務。 原網站預計持續維運至 2021年底，網站內容基本上不會再更動。本網站由 Denny Huang 備份封存。
也紀念我們永遠的朋友 李士傑先生（Shih-Chieh Ilya Li）。
Tech Column Doctorj

Doctorj

Created at Sunday, 14 October 2007 16:00      Last Updated on Monday, 15 October 2007 01:04 Written by 李日貴（松凌科技技術總監）

Java Opensources for Web Development Part I：
Chapter 5 檢測程式碼
Lession 21 : Doctorj

Java 程式碼的部份，利用 PMD 或是 Checkstyle 就可以將大多數的檢測出來，許多利用 JavaDoc 作為程式碼註解的開發團隊，就可以利用 doctorj 來檢查程式碼註解的部份是否有一些問題，例如拼字錯誤，或是參數順序有問題，這些都不算是編譯性的錯誤，所以開發工具無法針對這類錯誤進行除錯。

不過我們可以利用 Doctorj (https://www.incava.org/projects/java/doctorj/ ) 檢查 javadoc 內容是否是正確的，畢竟，提供正確的註譯對於未來整合或承接維護的工程師，能夠參考的最有價值文件。

其實利用 doctorj 的方法很簡單，當你下載解壓縮之後，先利用 ant install，進行所有的 compile 產生出 doctorj.jar ( 應該會在 /share/doctorj 的目錄之中 )，接著只要設定 set classpath=%classpath%;x:\xxxx\share\doctorj\doctorj.jar 即可。
我們只需要利用以下的指令進行檢測即可 ( 假設有存在 YourJavaFile.java )

java org.incava.doctorj.DoctorJ YourJavaFile.java

例如

*** Undocumented public class

    10.         Logger log = Logger.getLogger(this.getClass().getName());
                       <->                                                                                                    

屬於 public 的 attribute 應該要清楚說明相關的使用方式。

 

例如

    37.          * @return
            <----->
*** @return without description.

就是說明文件中 @return 應該要說明清楚回傳值到是什麼。

總之，如果要生成完整且具有可靠度的 javadoc，我會建議使用 doctorj 來進行最後文件輸出的把關工作。



OSSF Newsletter : 第 90 期 Linux 行動應用逐漸加溫

Category: Tech Column



↑ Top