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