JAVA基础 怎么写一个java程序说明

为什么要写说明书

我写好了一个JAVA程序卖给你，从源码可以看出这个程序的功能，
但是我肯定不能把源码给你看啊，
如果我把class丢给你 也不对劲，你看不懂二进制文件

所以最好的解决方案就是把class丢给你 顺便在配套送你个说明书。

怎么写一个java程序说明

java的说明书通常使用文档注释来完成

/**
第一行通常是描述信息：例子：这是一个数组工具类该类提供了排序，最值等功能。
@author 赵轩
@version V1.0
*/
public class ArraysTool{
	/**
	空参数的构造函数
	*/
	private ArraysTool(){
	}
	/**
	获取一个int数组中的最大值
	@param arr 接收一个int数组
	@return 返回一个int数组
	*/	
	public static int max(int[] arry){
	}
	public static void sort(){
	}
}

OK以上的文档注释写完了
然后进入cmd去生成工具书
需要使用bin目录下的javadoc
-d 存到哪个目录 （没有会自动建立）
-author 添加作者
-version 添加版本信息

javadoc -d help

要想把一个类生成文档 必须public