1 自動生成類的註釋
JavaDoc就是java特有的一種註釋。
1.1 配置
首先，IDEA點擊File-->Settings
然後Editor-->File and Code Templates-->Class
之後在這地方，添加一些代碼
/**
* ${description}
*
* <p>
* 創建日期：${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*
* @author 你的名字
* @since 創建該類時候的軟件版本號
* @version 當前軟件版本號
*/
直接把上面的代碼，全部拷貝過去。
添加完之後，這個部分的全部代碼應該是這樣的：
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* ${description}
*
* <p>
* 創建日期：${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*
* @author 你的名字
* @since 創建該類時候的軟件版本號
* @version 當前軟件版本號
*/
public class ${NAME} {
}
最後點擊OK
1.2 使用
剛纔我們做了什麼呢?其實就是爲了給java類自動添加必要的JavaDoc註釋
我們現在創建一個類試試，在任意包上右鍵單擊，創建一個Java Class
輸入類名，然後回車。
之後彈出窗口
這個是幹啥的？讓你輸入這個類的描述信息的，也就是說明你創建這個類，是幹啥的。
我們輸入一下（可以用中文）
之後OK
我們就創建好一個類了
這個時候，我們需要修改一下3個箭頭指向的地方，簡要說明
@author說明這個類的作者是誰@version說明最後修改完這個類的時候，這個軟件現在的版本號是多少【所以這個需要後期不斷改】@since說明第一次創建這個類的時候，版本號是多少
備註：還記得我們剛纔要求插入一段代碼，其實就是這個，如果你熟悉這幾個屬性的話，可以刪掉漢字的註釋，畢竟也挺麻煩的還得先刪除再寫上。
2 手動生成方法的註釋
剛纔，類有註釋了，那類方法也得有註釋對吧！
我們先寫個類
之後爲它寫註釋，注意下面的操作
首先輸入/**
然後按回車
兩個方法都是如此
之後變成了這樣
解釋一下
- 紅色方框：寫該方法的功能描述（中英文皆可）
- 綠色方框：寫參數的含義
- 橘色方框：寫返回值的含義
例如
注意，很多時候其實寫清楚功能就行，參數容易看懂，沒說明特別要求的話就刪掉即可
3 生成html文檔
你應該將jdk 11 的API文檔，我們也要生成類似的文檔。
首先，Tools-->Generate JavaDoc
點擊之後的界面
- 箭頭指向的是生成html的路徑，自己設置即可
- 方框的內容，要求和我的設定完全一樣，其他不用改
zh_CN
-encoding utf-8 -charset utf-8
之後點OK即可，會生成這些
你會發現我們剛纔的各種設置，都是沒有白費的
4 補充：JavaDoc
另外還有一個方法，就是直接查看java自帶類的文件
鼠標停留在String上，按住Ctrl鍵，之後單擊鼠標。
之後你就能查看String類的內容了，你會發現官方自帶類的Java Doc設定，和我們剛纔的要求是一樣的。