1. 程式人生 > >eclipse裡設定JavaDoc

eclipse裡設定JavaDoc

為了更好的生成註釋,在Java裡可以用JavaDoc很方便的生成註釋。

1。配置:

使用JavaDoc前,必須安裝jdk,因為JavaDoc需要用到jdk的一個exe檔案。

點選選單Project|Generate JavaDoc,第一次使用時需要指定javadoc的路徑:C:\Program Files\Java\jdk1.6.0_01\bin\javadoc.exe。

生成後的JavaDoc位於工程目錄的doc目錄,裡面有個index.html。


2。設定JavaDoc編碼:

如果Java檔案採用UTF-8編碼,產生JavaDoc時會報錯:編碼 GBK 的不可對映字元,這時需要配置javadoc的選項:-encoding UTF-8 -charset UTF-8

3。如何為Package生成註釋:

在每個Package目錄下放一個package.html,內容只需要<body></body>就可以了。其中body內的第一行為包概述,以英文.或中文。結尾,body內的所有內容為包描述。


package.html內容示例:

<BODY>
測試包。<BR />
這個測試包裡面包含含有main函式的測試用例。<BR />
</BODY>
包概述:

包描述: