【JavaDoc】生成JavaDoc文档

生成JavaDoc文档

方法一：命令行生成JavaDoc文档

例如：给以下的代码生成JavaDoc文档

代码内容如下：

package cn.tx.array;

import java.util.Arrays;

class Arr {

    //升序数组  方法： Arrays.sort(int[] a)
    public static void sort(int[] arr) {
        Arrays.sort(arr);
    }

    /*for循环遍历数组
     * for(int i=0;i<arr.length;i++) { System.out.print(arr[i]+"\t"); }
     */

    //将数组以字符串形式表示String arr1=Arrays.toString(int[] arr);
    public static void toString(int[] arr) {
        String arr1 = Arrays.toString(arr);
        System.out.println(arr1);

    }


    //二分法搜索求索引   方法： Arrays.binarySearch(int[] arr,int value);   value是所要求的索引的数
    public static void binarySearch(int[] arr, int value) {
        int key = Arrays.binarySearch(arr, value);
        System.out.println(value + "的索引是" + key);

    }


}

public class TestArr {
    public static void main(String[] args) {
        int[] arr = {15, 5, 32, 63, 3, 9, 27, 4, 79};
        Arr.sort(arr);
        Arr.toString(arr);
        Arr.binarySearch(arr, 27);
    }
}

第一步：在文件路径前加cmd+空格，然后回车，快捷跳转至当前路径的命令窗口（该操作可节约时间）


第二步：输入命令如下命令回车

javadoc -encoding UTF-8 -charset UTF-8 TestArr.java

javadoc : java生成文档的一个命令
encoding ：设置编码为UTF-8
charset ：设置字符集编码为UTF-8

结果：文件夹中生成了许多其他的文件

第三步：打开index.html

---

方法二：IDEA生成JavaDoc文档

第一步：IDEA中选中需要生成文档的代码

第二步：在工具栏中找到 Tool，然后再子菜单中找到 Generate JavaDoc

第三步：设置

注释：设置编码

-encoding utf-8 -charset utf-8 

---