IntelliJ Idea註釋模板--類註釋、方法註釋

剛從Eclipse切換到IntelliJ Idea，以前使用eclipse時用到了註釋模板，包括類註釋和方法註釋，如今分別講一下在Intellij Idea中如何進行配置，做爲備忘

一. 類註釋模板配置

1. 配置效果

2. 配置方法

 【File】-->【settings】-->【Editor】-->【File and Code Templates】-->【Files】-->【Class】

 

一. 類註釋模板配置

 1. 配置效果

 

注意：關於參數的註釋，網上有一些配置是將多個參數列在一行，形如：@param [a, b]，固然網上也提供了將多個參數列成多行的形式，即上圖所示效果，這是用腳本實現的，可是網上的腳本因空格問題，總是對不齊，本人有強迫症，修改了一下（起始就是去了個空格），使之對的比較整齊，如上圖所示效果。

 

2. 配置方法

IDEA尚未智能到自動爲咱們建立方法註釋，這就是要咱們手動爲方法添加註釋，使用Eclipse時咱們生成註釋的習慣是：/**+Enter，這裏咱們也按照這種習慣來設置IDEA的方法註釋。

（1）打開頁面配置

 

（2）建立模板組

【Editor】 --> 【Live Templates】 --> 【點擊「+」】 --> 【Template Group】 --> 【輸入名稱，點擊OK（我輸入的是My Group）】，以下圖中步驟1~4

 

（3）建立模板

        選中新建的模板組（My Group） --> 點擊「+」 --> 1.Live Template，如上圖中步驟5~6

 （4）模板設置：

• 　　1.設置模板前綴，若是設置爲，使用時 /* + Enter鍵（第5步設置該按鍵），若是設置爲a，使用時 /*a + Enter鍵，其餘類推
• 　　2.設置該模板應用範圍，mothed表示方法，file表示類上面
• 　　3.填寫模板內容，具體內容會在後面補充，能夠參考
• 　　4.設置模板中變量的取值
• 　　5.設置執行按鍵，默認是Tab，我通常習慣改成Enter鍵。該功能主要配合步驟1中的模板前綴使用
• 　　6.設置模板應用範圍，通常是點擊第一個進行全選操做。

 

（5）模板內容

　　設置模板內容，如上圖步驟3位置所示：

*
* @Description TODO
$params$
* @Return $return$
* @Author duzhijie
* @Date $date$ $time$
**/

 

（6）設置模板變量的取值，對應上圖步驟4操做，以下

         在這裏設置模板變量取值，或者用腳本，或者用idea自帶的方法，如 

  方法參數param取值的腳本以下所示：

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) ? '\\r\\n' : '')}; return result", methodParameters())

注意：只有用這個腳本，多個參數纔是纔是各佔一行，若是用　methidParameters()，則多個參數會只佔一行，形如：@param [a, b]，