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

JavaDoc的知識，有興趣可以學習

參考鏈接2

另外還有一個方法，就是直接查看java自帶類的文件

鼠標停留在String上，按住Ctrl鍵，之后單擊鼠標。

之后你就能查看String類的內容了，你會發現官方自帶類的Java Doc設定，和我們剛才的要求是一樣的。

總結

以上是生活随笔為你收集整理的IEDA中JavaDoc的自动生成、手动生成，以及生成html文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。