IDEA類和方法註釋模板設定
IDEA中設定註釋模板主要分為兩個部分，分別是建立java檔案時類的註釋和方法的註釋。
一、設定類的註釋模板
我們選擇Class檔案（當然你要設定介面的還也可以選擇Interface檔案）
-
${NAME}：設定類名，與下面的${NAME}一樣才能獲取到建立的類名
-
TODO：代辦事項的標記，一般生成類或方法都需要新增描述
-
${USER}、${DATE}、${TIME}：設定建立類的使用者、建立的日期和時間，這些事IDEA內建的方法，還有一些其他的方法在綠色框標註的位置，比如你想新增專案名則可以使用${PROJECT_NAME}
-
1.0：設定版本號，一般新建立的類都是1.0版本，這裡寫死就可以了
/**
* @package ${PACKAGE_NAME}
* @project ${PROJECT_NAME}
* @description [型別描述]
* @createTime ${DATE} ${TIME}
* @author <a href="mail to: [email protected]" rel="nofollow">${USER}</a>
* @version v1.0
* @update [序號][日期YYYY-MM-DD] [更改人姓名][變更描述]
*/
如果移動程式碼到Includes的File Header則應用到所有檔案。因為每個檔案都有這句話#parse("File Header.java")。
二、設定方法的註釋模板
- 選擇File→Settings→Editor→Live Templates。點選右邊的加號，選擇Template Group，建立一個分組。名字任意。
- 選中剛剛新建的group，再點選加號，選擇Live Template，建立一個模板。其中：
Abbreviation：填模板的縮寫，可以使用號作為代號，方便後面呼叫模板。（因為我們後面會用/然後按tab建所以/*已經輸入了，模板裡面不需要了）
Options→Expand with：填註釋模板的擴充套件快捷鍵，根據使用習慣，這裡使用預設的Tab。
Template text：填寫註釋模板的內容。引數名使用${引數名}$的格式。（注意：註釋模板開頭的/不要填寫，原因可以看文章末尾的解釋）
-
點選模板頁面最下方的警告define，來設定將模板應用於哪些場景，選擇Everywhere-->Java即可。（如果曾經修改過，則顯示為change而不是define，如上圖）
-
然後點選Edit variables，會讀取剛剛在註釋模板中的配置的引數${引數名}$。在Expression的下拉框中選擇方法為其賦值。
-
註釋模板的呼叫。在我們的方法上方通過輸入 / + * (是我們剛設定的快捷鍵，對照自己設的） + Tab鍵 （右邊設定的Expand with)，即先輸 / 再按Tab鍵，就可以呼叫模板。因為剛剛我們把*被設定為模板的代號，Tab鍵設定為模板的擴充套件快捷鍵，也可以把Tab改為Enter鍵。
PS:註釋模板中的user引數是獲取系統的使用者（當然註釋作者也可以直接寫固定值，但是配置更有意思，哈哈），經常不是自己需要的作者名，可以在IDEA中進行配置。開啟→IDEA的安裝目錄\bin\idea64.exe.vmoptions或者idea64.vmoptions。在最下面增加一行-Duser.name=username。其中username就是你希望為user引數的賦值。