在实际开发中，我们经常需要生成文档注释，下面简单记录一下如何生成文档注释，以下是使用EditPlus编写的java文档生成的注释。
帮助文档:
1)使用JDK,JDK中类有很多,都可以使用,了解这些类的使用方式,类的功能,变量,方法,怎么使用, JDK给开发人员提供了帮助文档 API
2)自己的项目中,开发的功能,需要给客户提供对应的操作手册,方便客户进行功能的运行
注释: 文档注释,注释中包含了一些注解,能针对于写的类或者方法进行比较具体和详细的描述, 文档注释可以生成帮助文档
dos命令生成操作手册:
javadoc -d api -author -version 源文件
javadoc : JDK的bin路径下的一个命令,作用生成操作手册(帮助文档)
-d : directory 表示目录的意思生成的操作文档会存放在一个目录(文件夹)下
api : 存放操作手册文档的目录
author : 表示操作手册中会生成作者
version : 表示操作手册中会生代码版本
源文件: 想要让哪个类生成对应的文档,源文件写上
生成了操作文档后,到api文件夹下,找到index.html,双击查看
java文件示例：
/**@author xlt@version 1.0*/public class ArrMax {public static void main(String[] args) {int[] arr = {2,3,-9,99,78,-1};int max = getMax(arr);System.out.println(max);}/**求数组最大值@param arr 数组@return max,输出数组最大值*/public static int getMax(int[] arr){if(arr!=null&&arr.length!=0){int max = arr[0];for(int i =0;i<arr.length;i++){if(max<arr[i]){max = arr[i];} }return max;}else{System.out.println("数组不能为null或者数组长度不能为0");return 0;}}}接下来找到文件，生成注释，打开cmd命令
生成之后接下里打开api文件夹中查看
双击打开一个叫做index.html的网页文件,就是操作文档