转载

JAVA 文档注释，类的说明，HTML说明文档的生成

有的时候，我们会写一些类，编译成.class文件，给别人使用，那么，别人不知道这个类有哪些方法，如何调用。

所以我们需要做一个类的说明文档。

可以采用在.java类里面进行注释，通过注释来生成类的说明文档的方法。

一、.java中注释的写法：

Test1.java

/* 文档注释 */ /** 此类是对数组进行取最值，排序等操作的 @author 张三 @version 1.0 */ public class Test1{  /**  取Int数组里面的最大值  @param arr 传入一个int数组  @return 返回一个Int数值  */  public static int max(int[] arr){   int j = arr[0];   for(int i=0;i<arr.length;i++){    if(j<arr[i]){     j = arr[i];    }   }   return j;  }  /**  取Int数组里面的最小值  @param arr 传入一个int数组  @return 返回一个Int数值  */  public static int x(int[] arr){   int j = arr[0];   for(int i=0;i<arr.length;i++){    if(j>arr[i]){     j = arr[i];    }   }   return j;  } }

ps：

注释采用/**开始，用*/结尾

@author 作者

@version 版本

@param arr 传入的值（arr是方法参数名称，是什么参数名，这里填写什么，后面“传入的值”，这几个字是参数名的说明）

@return 返回的值（返回什么填写什么，前面，“返回的值”这几个字是返回值的说明）

注意：此类要写public 否则无法生成说明文档

二、在dos中采用以下命令生成说明文档

javadoc -d Mydoc1 -author -version Test1.java

ps：

1、以上命令Mydoc1是生成后的文件保存目录

2、-author是生成作者

3、-version是生成版本号

三、生成后的说明文档文件结构截图：

JAVA 文档注释，类的说明，HTML说明文档的生成

生成后，保存的文件是网页文件.html的，双击index.html即可用浏览器打开查看

查看效果截图：

JAVA 文档注释，类的说明，HTML说明文档的生成

在这个说明文档中，有构造函数的说明，如果我们需要取消，只需要把构造函数定义为私有的，就可以了，代码如下：

/* 文档注释 */ /** 此类是对数组进行取最值，排序等操作的 @author 张三 @version 1.0 @addDate 2015-05-31 */ public class Test1{  private Test1(){  }  /**  取Int数组里面的最大值  @param arr 传入一个int数组  @return 返回一个Int数值  */  public static int max(int[] arr){   int j = arr[0];   for(int i=0;i<arr.length;i++){    if(j<arr[i]){     j = arr[i];    }   }   return j;  }  /**  取Int数组里面的最小值  @param arr 传入一个int数组  @return 返回一个Int数值  */  public static int x(int[] arr){   int j = arr[0];   for(int i=0;i<arr.length;i++){    if(j>arr[i]){     j = arr[i];    }   }   return j;  } }