一、類註釋

開啟 IDEA 的 ，點選 ，點選右邊  選項卡下面的 ，在其中新增圖中紅框內的內容：

在我提供的示例模板中，說明了作者和時間，IDEA 支援的所有的模板引數在下方的  中被列出來。

儲存後，當你建立一個新的類的時候就會自動新增類註釋。如果你想對介面也生效，同時配置上圖中的  項即可。

二、方法註釋

不同於目前網路上互相複製貼上的方法註釋教程，本文將實現以下功能：

根據形引數目自動生成  註解

根據方法是否有返回值智慧生成  註解

相較於類模板，為方法添加註釋模板就較為複雜，首先在 中點選 。

點選最右邊的 ，首先選擇  來建立一個模板分組：

在彈出的對話方塊中填寫分組名，我這裡叫做 userDefine：

然後選中剛剛建立的模板分組 ，然後點選 ，選擇 ：

此時就會建立了一個空的模板，我們修改該模板的 、 和 。需要注意的是， 必須為，最後檢查下  的值是否為 Enter 鍵。

上圖中·  內容如下，請直接複製進去，需要注意首行沒有 ，且  是頂格的。

注意到右下角的  了嗎，這說明此時這個模板還沒有指定應用的語言：

點選 ，在彈框中勾選，表示將該模板應用於所有的 Java 型別檔案。

設定 applicable contexts

還記得我們配置  時裡面包含了類似於  這樣的引數，此時 IDEA 還不認識這些引數是啥玩意，下面我們對這些引數進行方法對映，讓 IDEA 能夠明白這些引數的含義。點選  按鈕：

為每一個引數設定相對應的 ：

設定 Expression

需要注意的是， 和  的  使用的是 IDEA 內建的函式，直接使用下拉框選擇就可以了，而  這個引數 IDEA 預設的實現很差，因此我們需要手動實現，程式碼如下：

另外  這個引數我也自己實現了下，程式碼如下：

注：你還注意到我並沒有勾選了  屬性，它的意思是如果在生成註釋時候如果這一項被定義了，那麼滑鼠游標就會直接跳過它。我並不需要這個功能，因此有被勾選該屬性。

點選 OK 儲存設定，大功告成！

三、檢驗成果

3。1 類註釋

類註釋只有在新建類時才會自動生成，效果如下：

類註釋

3。2 方法註釋

將演示以下幾種情況：

無形參

單個形參

多個形參

無返回值

有返回值

方法註釋

四、Q & A

（1）為什麼模板的  一定要叫  ？要保證是 Enter 鍵？

答：因為 IDEA 模板的生成邏輯是 ，當生成鍵是 Enter 時，我們輸入  就能夠觸發模板。

這也同時說明了為什麼註釋模板首行是一個  了，因為當我們先輸入 ，然後輸入 ，觸發模板，首行正好拼成了 ，符合 Javadoc 的規範。

（2）註釋模板中為什麼有一行空的 ？

答：因為我習慣在這一行寫方法說明，所以就預留了一行空的寫，你也可以把它刪掉。

（3）註釋模板中  這兩個明明不相干的東西為什麼緊貼在一起？

答：首先網上提供的大部分 param 生成函式在無參情況下仍然會生成一行空的 ，因此我對param 函式的程式碼進行修改，使得在無參情況下不生成 ，但是這就要求  要和別人處在同一行中，不然沒法處理退格。

（4）為什麼 return 引數不使用 ， 而要自己實現？

答： 在無返回值的情況下會返回 void，這並沒有什麼意義，因此我對 methodReturnType（） 返回值進行了處理，僅在有返回值時才生成。

（5）為什麼  不是單獨一行？

答：因為當  返回 null 時，無法處理退格問題，原因同第三點。

版權申明：內容來源網路，版權歸原創者所有。除非無法確認，我們都會標明作者及出處，如有侵權煩請告知，我們會立即刪除並表示歉意。謝謝！

感謝閱讀