2018/01/01Java基础学习——如何通过dos系统的javadoc命令生成API文档

通常在Java原程序中插入类似这样的注释，/** ... ... */这样的格式可以通过Javados命令生成doc帮助文档。代码案例如下：

import java.util.Arrays;
 
/**
 * Description
 * <br> this's a test class
 * Created by test on 2017/2/7.
 * @author MisJersion
 * @version 1.8
 */
public class HelloWorld{
       public static void fill(int[][] array) {
            /**
             * 执行赋值操作
             */
            for (int i = 0; i < array.length; i++) {
                for (int j = 0; j < array[i].length; j++) {
                    array[i][j] = (int) (Math.random()*100);
                }
            }
        }
        public static void sort(int[][] array) {
            /**
             * 先把二维数组使用System.arraycopy进行数组复制到一个一维数组
             * 然后使用sort进行排序
             * 最后再复制回到二维数组。
             */
            int[] a = new int[array.length * array[0].length];
            int b = 0;
            int c = 0;
            for (int i = 0; i < array.length; i++) {
                System.arraycopy(array[i],0,a,b,array[i].length);
                b += array[i].length;
            }
            Arrays.sort(a);
            System.out.println(Arrays.toString(a));
            for (int i = 0; i < array.length; i++) {
                System.arraycopy(a,c,array[i],0,array[i].length);
                c += array[i].length;
                System.out.println(Arrays.toString(array[i]));
            }
        }
        public static void main(String[] args) {
            int[][] a = new int[5][8];
            fill(a);
            sort(a);
        }
}

下面讲解如何生成doc帮助文档

方法一：

1. 打开dos界面：win + R， 然后输入cmd
2. 拿我自己的.java路径来举例，输入：E:+enter
3. 输入：cd E:\project\j2se\src，然后enter
4. javadoc 类名.java，然后enter
5. 打开根目录E:\project\j2se\src，找到index.html索引网页，双击打开，就可以查看了
6. 点击其中的类，可以看到相应类的信息，如你设置的版本、作者，还可以看到继承的类等信息，有助于快速了解源代码

　　方法一的优点是快速，其实还有一种更快的方式，但是建成的.HTML文件比较乱。所以推荐了下面的方法。

方法二：参考链接： 如何使用javadoc命令生成api文档、文档注释

1. 第一步方法同『方法一』的前三步
2. 创建api文件，进行文档生成：输入『javadoc -d javaapi -header 测试的API -doctitle 这是我的第一个文档注释 -version -author 类名.java』
3. 打开根目录E:\project\j2se\src：可以看到生成了一个文件夹javaapi，这样就不乱了。

　　 

　　【note注意】上述的类名.java在这里是HelloWorld.java。