java文檔注釋--javadoc的用法，java注釋--javadoc

java文檔注釋--javadoc的用法，java注釋--javadoc

1.前言

Java中有三種注釋方式。前兩種分別是 // 和 /* */，主要用於代碼的注釋，以此來方便代碼的可讀性。第三種被稱作說明注釋或文檔注釋，它以 /** 開始，以 */結束，文檔注釋允許你在程式中嵌入關於程式的資訊，有了這個注釋就可以使用 javadoc 工具軟體來產生資訊，並輸出到HTML檔案中。

2.文檔注釋的格式

/**
* .........
* .........
*/

在開始的 /** 之後，第一行或幾行是關於類、變數和方法的主要描述。

之後，你可以包含一個或多個各種各樣的 @ 標籤。每一個 @ 標籤必須在一個新行的開始或者在一行的開始緊跟星號(*)，其中常用的標籤如下（詳細標籤請參考http://www.runoob.com/java/java-documentation.html）：

標籤	描述	樣本
@author	標識一個類的作者	@author description
@version	指定類的版本	@version info
@param	說明一個方法的參數	@param parameter-name explanation
@return	說明傳回值類型	@return explanation

 

 

 

 

 

 下面是一個類的說明注釋的執行個體:

 1 /** 我的數組協助類 2 *定義一個用於運算元組的工具類。 3 *比如：擷取最值，排序，折半。 4 *@author 張三 5 *@version V1.0 6 */ 7 public class ArrayTool 8 { 9 10     /**11     該類的空參數建構函式。12     */13     private ArrayTool(){}14 15     /**16     擷取int數組的最大值。17     @param arr 用於接收一個int類型的數組。18     @return 返回該數組中的最大值。19     */20     public static int getMax(int[] arr)21     {22         int max = arr[0];23         for(int x=1; x<arr.length; x++)24         {25             if(arr[x]>max)26                 max = arr[x];27         }28 29         return max;30     }31     /**32     對int數組進行從小打到的排序。33     @param arr 用於接收一個int類型的數組。34     */35     public static void bubbleSort(int[] arr)36     {37     }38 }

3. 使用javadoc產生文檔

 命令： javadoc -d 文檔存放目錄 -author -version 源檔案名稱.java

這條命令編譯一個名為"源檔案名稱.java"的 java 源檔案，並將產生的文檔存放在"文檔存放目錄"指定的目錄下，產生的文檔中 index.html 就是文檔的首頁。-author 和 -version 兩個選項可以省略

4.測試樣本

4.1 操作命令

4.2 開啟help檔案夾下的index.html