idea設置file template
在使用idea創建類或者接口文件時,idea都是使用file template裏面定義好的模板格式
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
public class ${NAME} {
}
然而默認的模板並沒有生成自己需要的註釋,那麼我們怎麼去配置呢?
其實這個模板設定的語言是Apache Velocity,但是我們不需要深入去了解這個,因爲idea已經給定了很多的變量,我們只要學會怎麼去使用就行了。
變量名稱 | 解釋 |
---|---|
${PACKAGE_NAME} | 新建類所在包的路徑 |
${NAME} | 新建類的名稱 |
${USER} | 當前計算機的用戶名 |
${DATE} | 當前系統日期,例:9/26/2019 |
${TIME} | 當前系統時間,例:10:13 |
${YEAR} | 當前年份 |
${MONTH} | 當前月份 |
${MONTH_NAME_SHORT} | 當前月份英文單詞簡寫,例:Feb |
${MONTH_NAME_FULL} | 當前月份英文單詞全拼,例:February |
${DAY} | 當前月的日期 |
${HOUR} | 當時的小時 |
${MINUTE} | 當時的分鐘 |
${PROJECT_NAME} | 當前項目的名稱 |
好了,變量名都弄清楚了,那麼看一下精簡的Java類的創建模板吧。其中用@author表明此類的作者,用@date註解標明文件文件創建日期,其上方默認爲文件的描述相關信息。並用todo標明以方便提醒自己修改。
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* todo 待增加類描述
*
* @author ***
* @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
*/
public class ${NAME} {
}
另外由於工作的開發環境我用個人姓名標識,個人平時的開發使用郵箱來標識,因而標明的@author信息不同,所以想通過一種方式來自動判斷是工作環境還是個人開發環境。由於目前公司開發的包名前綴固定,所以想通過包名來判定,於是我便把模板修改了一下:
#set($str=${PACKAGE_NAME})
#if($str.length() > 16)
#set($str=$str.substring(0, 16))
#end
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
*
* @author
#if ($str.length() == "公司包名前綴") your name
#else ****@email.com
#end
* @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
*/
public class ${NAME} {
}