idea添加注解自定義模板

1     IDEA自定義快捷鍵（用於注釋）

1.1    創建自定義快捷鍵分組

1.1.1    添加自定義快捷鍵分組

 

 

 

 

1.1.2    給分組取名

 

1.1.3    創建完分組后再創建分組內的成員（我們自定義快捷鍵）

 

 

 

 

PS：比如說我們Abbreviation中應為為小寫字母“a”，那么自定義的這組快捷鍵即為——先輸入  a 在按下回車鍵（Enter）；

快捷鍵也可以定義為Tab鍵跟空格鍵。

 

2     IDEA注釋模板

2.1    設置模板

2.1.1    文件頭部

 

1、 模板

/**  
 * 
 * @author: XXX
 * @date: ${YEAR}-${MONTH}-${DAY} ${TIME}
 */

 

 

2、 示例圖

 

 

 

 

5.1.2    類注釋標簽

1、 一創建類就會自動添加注釋；

2、 模板（可復制）

/**  
 * {闡述類的作用}
 * @author: XXX

 * @date: ${YEAR}-${MONTH}-${DAY} ${TIME}
 */

3、 示例圖

 

4、 接口同上

 

 

 

 

5.1.3    字段 (Fields)注釋標簽

字段注解標簽直接使用：  /** + 回車鍵

2.1.4    構造函數標簽

 

1、 所有的函數描述都寫在最上面

 

2、 模板（可復制）

**
 *
$params$
 **/

 

 

3、 示例圖

 

 

 

 

 

 

 

 

 

4、 Edit variables 配置

Edit variables是用來配置我們模板內容中$名稱$（如：$title$），所要顯示的值是什么。

 

 

 

 

Params中Default value的值為： groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

（ps：：千萬不能用myeclipse或eclipse的方法（如：時間: ${DATE}）去寫格式，idea的注解方式跟他們不一樣。Template text內的內容跟idea所規定的內容不一致，那么圖中  Edit variables將無法點擊。）

5、 如何操作

 

 

 

 

       文字描述： 首先在構造函數上方 輸入 /c ，然后在按回車鍵

 

 

 

2.1.5    方法 (Methods)標簽

1、模板（可復制）

**
$params$
 * @return: $return_tpye$
 * @author: bz
 * @date: $date$  $time$ 
 **/

2、 示例圖

 

 

 　　

3、Edit variables 配置

     

 

 

　　a)、Params中Default value的值為： groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

 

       b)、date中的Expression要這樣操作：先選擇系統給的date()，然后保存。在進去修改將date()改成date(“yyyy-MM-dd”)才能將時間格式化

5、 如何操作

 

 

 

文字描述： 首先在方法上方 輸入 /m ，然后在按回車鍵

 

6、 注解內容

 

 

 

 

2.1.6    其他注釋

直接使用idea自帶定義的快捷注釋方法=====》 /** + 回車鍵

             

3     注釋顯示

3.1    鼠標移到方法或字段上顯示注釋

3.1.1    配置圖示

 

 

PS：單行注解請放置所需注解代碼上頭，使用//。多行注解使用/* */ 進行注解。絕不允許行尾注解出現！