Java基础24-文档注释

格式:

/** .......*/

 1 /**
 2 此类是对数组进行取最大值
 3 @author 深海溺心
 4 @version 1.0
 5 */
 6 public class Compare{
 7     private Compare(){
 8     }
 9     /**
10     此静态方法取int数组里面的最大值
11     @param arr 传入一个int数组
12     @return 返回一个int数值
13     */
14     public static int max(int[] arr){
15         int max=arr[0];
16         for(int i=0;i<arr.length;i++){
17             if(arr[i]>max){
18                 max=arr[i];
19             }
20         }
21         return max;
22 }
23 }

如何获取文档?

  jdk的安装目录bin文件下有javadoc.exe,用这个在cmd中即可获得(注意:编码最好转为ANSI编码,不然获取到的文档乱码)

  cmd,进入存放源文件的文件路径,然后输入javadoc -d Mydoc -auto -version Compare.java,然后就可以在创建的文件下看到文档(html形式)

    -d Mydoc会自动在该路径下创建名为Mydoc的文件夹

    -auto 要求输出作者

    -version 要求输出版本

 

posted on 2018-12-08 16:47  深海溺心  阅读(135)  评论(0编辑  收藏  举报

导航