Java的注釋

標籤：row   dir   java   文檔   傳回值   描述   return   nbsp   一個   

1. 單行注釋
2. 多行注釋
3. 文檔注釋

單行注釋：在需要注釋的內容前面加上雙斜線(//)

多行注釋：將需要注釋的內容用 /*  */ 包含起來

文檔注釋：/**  */  文檔注釋用於產生API文檔(使用javadoc來產生)，API文檔主要用來說明類、成員變數、方法的功能。所以，javadoc工具只處理在類、介面、內部類、成員變數、方法、構造器前的注釋。而且，預設用private修飾的方法或者成員變數等不產生注釋文檔，除非在使用javadoc工具的時候加上-private參數。

 

javadoc工具的基本用法：

　　javadoc 一堆參數 java源檔案（或者包）

可帶的參數有：

-d <directory> 　　　　指定將產生的API文檔放在那個目錄下

-windowtitle <text> 　　設定API文檔的瀏覽器視窗標題

-author　　　　　　　在文檔中顯示author(需要注釋中有指明author)

-version　　　　　　  在文檔中顯示version

-charset        　　　　  指定API文檔的編碼，如 -charest utf-8

其他更多的參數 使用javadoc --help (linux系統)查看

 

在寫文檔注釋的時候可以用的一些標記：

@author　　　　　　作者

@version　　　　　   版本

@param　　　　　　方法的參數說明

@return　　　　　　方法的傳回值

@see　　　　　　    參見，指定參考內容

@exception　　　　  拋出的異常的類型

@throws　　　　　   和exception一樣

 

可以在每個包中建立一個package.html對包進行描述，然後通過 javadoc 一堆參數 包 直接將包中的所有類的注釋提取到API文檔中

Java的注釋