一個好的程式設計師,我認為是有好的習慣, 好的習慣之一就是會詳細的寫下程式註解, 寫下註解後可以透過 Eclipse 來產生跟 API 一樣的文件(HTML),
如右圖,選擇 Project-->Generate Javadoc,開啟「Generate Javadoc」視窗, 如右圖,在下面的Destination中,可以直接輸入Javadoc產生的資料夾,或經由Browse指定。然後按Next, 如右圖,選擇要產生的option及tag後按Next, 如右圖,這裡有個最重要的地方;因為我的註解幾乎都是輸入中文,所以在產出Javadoc的時候會有編碼的問題, 因此要解決很簡單,只要加入這行「-encoding UTF-8 -charset UTF-8」,先編碼,再解碼即可。 然後可能專案很大,寫的程式可能上萬支,這時候 JVM 可能會撐不住的,所以可以再加入這行「-J-Xmx32m」, 其中32可以寫到180; 因此最後在該欄位加入的是「-encoding UTF-8 -charset UTF-8 -J-Xmx128m」, 就可以順利產出Javadoc了。
沒有留言:
張貼留言