示例:
/** * Title: Person類<br/> * Description:通過Person類說明Java中的文檔註釋<br/> * Company: *** * @author *** * @version 1.0 */public class Person { /** * 這個是Person類的構造方法* @param name Person 的名字* */ public Person(String name) { //執行語句; } /** * 這是read()方法說明* @param bookName 讀的書的名字* @param time 讀書所用的時間* @return 讀的書的數量* */ public int read(String bookName, int time) { //執行語句; return 1; }}生成命令
person Mac$ javadoc -d . -version -author Person.java
注意Person.java路徑名要正確。
效果:
其中index.html為主頁,打開如下圖:
以上這篇Java的文檔註釋之生成幫助文檔的實例就是小編分享給大家的全部內容了,希望能給大家一個參考,也希望大家多多支持武林網。