Java基礎-知識點總結-Java幫助文檔的生成

Java幫助文檔的生成

Java幫助文檔

 

      若要生成幫助文檔，則需要使用文檔註釋符“/**   */”,

 

在註釋符中需要寫

 

1. 類的功能描述和各個方法的功能描述

2. @author 作者名   @version 版本號  用於描述本類的作者和版本號

3. @param 參數名 參數說明（有幾個參數描述幾個@param）  @return對返回值的描述  用於描述方法的參數和返回值

          注意：需要生成幫助文檔的Java類文件必須使用public修飾；如要在幫助文檔中看到某個方法的方法描述，則該方法必須使用public修飾

例：

 

 

/**
 * 一個可以對數組進行簡單操作的工具類，該類提供了獲取數組的最大值和最小值
 * 
 * @author 張三
 * @version 1.1
 */
public class ArrayTool {
	private ArrayTool() {
	};

	/**
	 * 獲取一個整形數組元素中的最大值
	 * 
	 * @param arr
	 *            接收一個整形數組
	 * @return 返回該數組元素中的最大值
	 */
	public static int getMax(int[] arr) {
		int max = 0;
		for (int x = 1; x < arr.length; x++) {
			if (arr[max] < arr[x])
				max = x;
		}
		return arr[max];
	}

	/**
	 * 獲取一個整形數組元素中的最小值
	 * 
	 * @param arr
	 *            接收一個整型數組
	 * @return 返回該數組元素中的最小值
	 */
	public static int getMin(int[] arr) {
		int min = 0;
		for (int x = 1; x < arr.length; x++) {
			if (arr[min] > arr[x])
				min = x;
		}
		return arr[min];
	}
}

 

 

 

 

 *用DOS命令行生成幫助文檔的命令：javadoc

 

         -d:用於指定生成的幫助文檔的存放位置

 

              -author:用於顯示該java文件的作者

 

              -version:永駐顯示該java文件的版本號

 

         javadc –d myhelp –author –version ArrayTool.java