java学习-文档注释/** */生成帮助文档

文档注释的写法：/**内容 */

例子：

package test;
/***
 * 
 * @author 张
 * @version v1.0
 * @since jdk8.0
 * 
 */
public class Demo{
	/**
	 * 此方法用来变量int类型数组
	 * @param a:要遍历的数组
	 * */
	public static void bianli(int[] a) {
		for (int i = 0; i < a.length; i++) {
			System.out.println(a[i]);
		}
	}
	/***
	 * 
	 * @param a:要获取最大值最小值的数组
	 * @return name:最大值,最小值
	 */
	public static int[] gatMaxAndMin(int[] a) {
		int max=0;
		int min=0;
		for (int i = 0; i < a.length; i++) {
			if (a[max]<a[i]) {
				max=i;
			}
			if (a[min]>a[i]) {
				min=i;
			}
		}
		System.out.println("max="+a[max]+"\tmin="+a[min]);
		int[] name = {a[max],a[min]};
		return name;
	}
	/***
	 * 
	 * @param a:要反转的数组
	 * @return a:反转后的数组
	 */
	public static int[] fanzhuan(int[] a) {
		int temp = 0;
		for (int i = 0; i < a.length/2; i++) {
			temp = a[i];//a0-a4 a1-a3 a2-a2
			a[i]=a[a.length-1-i];
			a[a.length-1-i]=temp;
		}
		return a;
	}
}

然后找到Demo.java文件的位置，自己的工程路径。
我这里是
在此位置打开命令行窗口（在文件目录输入cmd然后回车）

运行如下命令

javadoc -d  doc -author -version .\Demo.java

发现文件夹下生成了很多文件，.html结尾的都是静态网页文件。打开index.html，点击左边的Demo类。

可以看到生成的文档。
有了此文档，这样在没有源代码的时候也可以知道工程的信息