Idea-Java程式碼註釋規範
IDEA自帶的註釋模板不是太好用，我本人到網上搜集了很多資料系統的整理了一下製作了一份比較完整的模板來分享給大家（如果嫌配置繁瑣，可以在本頁面最下方下載jar包，匯入idea，就可以了）。
一、首先我們來設定IDEA中類的模板：（IDEA中在建立類時會自動給添加註釋）
1、File > settings > Editor > File and Code Templates > Files
我們需要設定的類模板有四個，Class、Interface、Enum、Annotation。
（1）${NAME}：設定類名，與下面的${NAME}一樣才能獲取到建立的類名
（2）TODO：代辦事項的標記，一般生成類或方法都需要新增描述
（3）${USER}、${DATE}、${TIME}：設定建立類的使用者、建立的日期和時間，這些事IDEA內建的方法，還有一些其他的方法在綠色框標註的位置，比如你想新增專案名則可以使用${PROJECT_NAME}
（4）1.0：設定版本號，一般新建立的類都是1.0版本，這裡寫死就可以了 
這裡貼出我的配置，Class、Interface、Enum、Annotation的配置都是一樣的，大家複製貼上即可，不要修改其他配置，直接點選"Apply"。
// Copyright 2016-2101 Pica. #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end /** *@ClassName ${NAME} *@Description TODO *@Author ${USER} *@Date ${DATE} ${TIME} *@ModifyDate ${DATE} ${TIME} *@Version 1.0 */ public class ${NAME} { }
我們新建一個類試試吧！
大家可以看到，該有的都有了。
二、接下來我們設定方法的註釋，這裡會比類註釋的設定稍微麻煩一點。
- File > settings > Editor > Live Templates
- 點選右側的" + "，新建模板組，名稱自定義，如下圖。
3.新建模板。
選中新建的模板組，點選右側的" + "，選擇"Live Template"
如下圖設定模板資訊。
這裡先點選藍色的"Define"，設定為"Java"，或者你想設定為全部也可以。
以下是完整配置。
*
*@Description TODO
*@Author $user$
*@Date $date$ $time$
*@ModifyDate $date$ $time$
*@Params $params$
*@Return $return$
*/
注意："Abbreviation"內的內容必須為“ * " （單個*號），"Template text"的內容開頭沒有" /* "。
點選"Edit variables"
請按照圖片配置"Expression"內容。
儲存後，新建一個方法，在新增方法註釋的地方，做"/**" + "Enter"的操作（與以前的操作一樣），即可看到設定的效果。