目錄

• 目錄
  • 生成類註釋
    • 生成類註解模板
  • 生成方法註釋
    • 生成方法註解模板

最近從eclipse轉idea了，第一步當然是配置快捷鍵，模板等。但是！發生了一件賊蛋疼的事情，竟然一直找不到正確新增方法註釋的方法！ 最後自己摸索到了，在此詳細記錄，供大家參考。

測試版本為idea for mac，可能快捷鍵不同，但是設定等肯定是相同的

• 1

生成類註釋

1. 開啟Preferences

2. Editor -> File and Code Templates -> Files -> Class
   

3. 效果圖
   

   
   網上很多都是在Includes的File Header裡面新增，在這裡面新增還需要自己去移動下滑鼠，然後再去操作鍵盤，再去寫description，，直接在建立類的時候就新增好description不更快嗎？

   • 在此新增的話你每次建立類的時候會彈兩次框，第二次是讓你輸入description的內容了，so, 這就是最優的方法

4. 同理，也可以在這兒為你的Interface，Enum新增上註釋

生成類註解模板

/**
* @program: ${PROJECT_NAME}
*
* @description: ${description}
*
* @author: Mr.Wang
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/

這裡的程式碼區顯示有問題，csdn有bug ，去掉裡面的中文就行了。

生成方法註釋

1. 開啟Preferences
2. Editor -> Live Templates -> 點選右邊加號為自己新增一個Templates Group -> 然後選中自己的Group再次點選加號新增Live Templates
   

3. 然後設定自己喜歡的快捷鍵 在Abbreviation裡面 記得在Applicable in 裡面勾選,起碼也要勾選class
   

4. 然後在Edit variables裡面新增引數和返回值的自動取值
   

   
   Expression裡面選擇就是了
   

5. 然後再你的方法上面直接輸入/ + 你設定的Abbreviation快捷鍵 + tab鍵就直接生成了 （我設定的是/+ a + tab）
   效果圖：
   

   
   裡面的引數和返回值都是根據你在Edit variables裡面新增的自動生成的，

生成方法註解模板


**
* @Description: $description$
* @Param: $params$
* @return: $returns$
* @Author: Mr.Wang
* @Date: $date$
*/


注意，這個和類註解模板有點不一樣，這個是用兩個$$ ，這個的作用就是生成後游標直接跳到當前位置，這樣也可以直接去輸入description的內容了

對於 Live Templates只能說真的很強大，你平常用的sout ,psvm什麼都是裡面的，大家可以自行百度一下學習一下。