IDEA中設置註釋模板的方法

　　IDEA中設置註釋模板主要分爲兩個部分，分別是建立java文件時類的註釋和方法的註釋。

　　這裏爲你們詳細介紹一下方法，按MyEclipse的風格設置（MyEclipse的請看：MyEclipse中設置註釋模板的方法），你們能夠根據本身的習慣生成本身喜歡的註釋模板。效果以下：

 

 

1、設置類的註釋模板

一、選擇File→Settings→Editor→File and Code Templates→Files→Class。能夠看到建立Class時引入了一個參數"File Header.java"。對應的是Files旁邊的Includes→File Header文件。

 

二、File Header裏就是建立類時的註釋模板，下面Description中有描述一些能夠配置的參數，能夠根據本身須要選用。

 

2、設置方法的註釋模板

一、選擇File→Settings→Editor→Live Templates。點擊右邊的加號，選擇Template Group，建立一個分組。

 

二、再點擊加號，選擇Live Template，建立一個模板。其中：

Abbreviation：填模板的縮寫，可使用*號做爲代號，方便後面調用模板。

Options→Expand with：填註釋模板的擴展快捷鍵，根據使用習慣，這裏使用默認的Tab。

Template text：填寫註釋模板的內容。參數名使用${參數名}$的格式。（注意：註釋模板開頭的/不要填寫，緣由能夠看文章末尾的解釋）

 

三、點擊模板頁面最下方的警告define，來設置將模板應用於哪些場景，選擇Everywhere-->Java便可。（若是曾經修改過，則顯示爲change而不是define，如上圖）

 

四、而後點擊Edit variables，會讀取剛剛在註釋模板中的配置的參數${參數名}$。在Expression的下拉框中選擇方法爲其賦值。

 

五、參數賦值優化

（1）若是param參數使用默認的methodParameters()來獲取方法參數值，其註釋參數是在一行展現的，以下圖。這裏咱們但願像MyEclipse中同樣，一行一個參數的樣式，能夠經過腳原本實現。將如下腳本複製進Expression，能夠獲得文章開頭效果圖的樣式：

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())

 

（2）若是return參數使用默認的methodReturnType()來獲取參數值，模板裏使用了@link來跳轉結果類型，那麼當方法返回值爲void時，註釋會報錯，以下圖。能夠經過腳原本避免，將上面模板中的@link參數去掉，將如下腳本複製進Expression：

groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())

 

六、註釋模板的調用。經過輸入 / + * + Tab鍵，即先輸 /* 再按Tab鍵，就能夠調用模板。由於剛剛咱們把*被設置爲模板的代號，Tab鍵設置爲模板的擴展快捷鍵，也能夠把Tab改成Enter鍵，更加還原MyEclipse。

 

PS:（1）注意，註釋模板開頭不要使用/，由於設置後雖然能夠更便捷的使用 * + Tab鍵，調用模板。可是會存在param爲null的狀況（緣由暫時未知），以下圖，須要在方法內調用才能獲取參數，但這樣還須要將註釋複製到方法外反而使用不便。

 

（2）註釋模板中的user參數是獲取系統的用戶（固然註釋做者也能夠直接寫固定值，可是配置更有意思，哈哈），常常不是本身須要的做者名，能夠在IDEA中進行配置。打開→IDEA的安裝目錄\bin\idea64.exe.vmoptions。在最下面增長一行-Duser.name=username。

其中username就是你但願爲user參數的賦值。