註釋(commentary )是程序中用於說明和解釋的一段文字對程序運行不起作用。程序 中添加註釋的目的是增強程序的可讀性。
Java提供3種註釋方式:。
單行註釋://
多行註釋/**/
文檔註釋:
/**
*文檔註釋用於從源代碼自動生成文檔執行javadoc
*命名根據源代碼中的內容生成網頁
*@XXX <-- 可以加入javadoc參數產生相應的文檔
*/
不同格式的註釋可以嵌套。
// Welcome1.java. Text-printing program.
/*計信學院09軟件工程2班
**姓名XXX
**2011年2月26日1800最後修改。*/
public class Welcome1
{
// main method begins execution of application
public static void main( String args[] ){
System.out.println( "梅花香子苦寒來!" );
}
}
文檔註釋參數說明
@see 生成文檔中的“參見xx 的條目”的超鏈接後邊可以加上“類名”、“完整類名”、“完整類名#方法”。可用於類、方法、變量註釋。@param 參數的說明。可用於方法註釋。@return 返回值的說明。可用於方法註釋。@exception 可能拋出異常的說明。可用於方法註釋。@version 版本信息。可用於類註釋。@author 作者名。可用於類註釋。
>javadoc first.java
javadoc命令javadoc [options] [packagenames] [sourcefiles]
-public 僅顯示 public 類和成員 -protected 顯示 protected/public 類和成員 (缺省)-package 顯示 package/protected/public 類和成員-private 顯示所有類和成員-d <directory> 輸出文件的目標目錄-version 包含 @version 段-author 包含 @author 段-splitindex 將索引分爲每個字母對應一個文件-windowtitle <text> 文檔的瀏覽器窗口標題
Eclipse中JavaDoc的生成方式
在項目列表中選擇項目按右鍵選擇Export導出然後在Export(導出)對話框中選擇java下的javadoc。
在Javadoc Generation對話框中有兩個地方要注意的 1javadoc command:應該選擇jdk的bin/javadoc.exe。 2destination:爲生成文檔的保存路徑。