JavaDoc生成文件

百度搜索：阿里巴巴開發手冊，仔細看！

百度搜索：java SE 文件——API和文件，即線上API幫助文件https://docs.oracle.com/javase/8/docs/api/，挑重點的有用的學習

文件註釋：加在類前面是類的註釋，加在方法前面是方法的註釋

package com.li.base;

/**
 * @author liyang
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     * @author liyang
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}
 

1. 通過命令列生成JavaDoc文件：

1. 在類上右鍵-->Open in-->Explorer
2. 在位址列輸入cmd，即在此類所在資料夾開啟控制檯
3. DOS命令：javadoc -encoding UTF-8 -charset UTF-8 Doc.java（ -encoding UTF-8 -charset UTF-8是為了解決可能出現的中文亂碼問題）
4. 資料夾會生成一堆檔案，開啟index.html
5. 便會看到生成的JavaDoc文件

生成的文件：

開啟檔案index.html後的介面

2. 通過IDEA生成JavaDoc文件：選中要生成的類-->Tools-->Generate JavaDoc...