IntelliJ IDEA 自定義創建類生成註釋模板

摘要:在創建類時,自動生成代碼的註釋模板

本篇內容爲大家提供的是IntelliJ IDEA 使用教程中的文件代碼模板的使用，自定義生成代碼註釋的模板。

文件代碼模板

文件代碼模板可以簡單理解爲：我們在項目中創建某些類型文件時，就已經在對應這些新文件中預設了代碼內容。因爲文字表達都帶有點無力，所以下面用 Gif 動態圖來演示。

如GIF演示一樣，可以看的出來，IntelliJ IDEA 默認新建類自帶的類註釋格式一般不夠友好或是規範，所以我們一般需要自己根據公司編碼規範進行設置。

下邊來看一下想要的結果，如下圖：

哎,是不是很有意思了,這樣就可以很方便的創建類的註釋了。
官網介紹：https://www.jetbrains.com/idea/help/file-and-code-templates.html

文件代碼模板的設置

Settings – Editor – File and Code Templates

• 如上圖標註 1 所示，文件代碼模板支持的類型基本常見的文件類型都涵蓋了。
• 如上圖標註 2 所示，這是 Java 文件模板新建的代碼模板，其中 ${PACKAGE_NAME}、${NAME} 是 IntelliJ IDEA 預設的變量。
• 如上圖標註 3 所示，IntelliJ IDEA 的文件代碼模板是可以使用 Velocity Template Language (VTL) 進行書寫的。如圖 2 上的 #if … #end 和 #parse 都是 VTL 的語法。
• 如上圖標註 4 所示，介紹當前文件模板的一些信息，以及一些預設變量的作用介紹。
• 如上圖標註 5 所示，這四個按鈕是文件代碼模板的主要操作按鈕，四個操作分別是：
  
  • Create Template 創建一個文件代碼模板。
  • Remove Template 刪除一個文件代碼模板，標註 1 所示的這些預設模板是不允許刪除的，只能能刪除預設之外的新增的。
  • Copy Template 複製一個文件代碼模板。
  • Reset To Default 對被修改的預設文件代碼模板，還原到默認狀態。

上圖中 – #parse(“File Header.java”) – 該句就是引用了 Includes 標籤下的 如下圖:

這個是我自己以前改的。其實改上圖這個地方和前邊截圖中的Class裏邊的代碼是一致的。如果在class那裏改的話，這句話就沒有必要加上去了。

• 如上圖標註箭頭所示，${DESCRIPTION} 是我們自己定義的變量，自定義變量格式有兩種方式：變量名或$變量名或$ {變量名}。

我的模板:

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
/**
 * 描述:
 *    ${DESCRIPTION}
 * @author ${USER}
 * @create ${YEAR}-${MONTH}-${DAY} ${TIME}
 */
public class ${NAME} {

}

可自行更改。

圖部分是我自己的，部分是原作者的，侵刪。

原文地址Github:
https://github.com/judasn/IntelliJ-IDEA-Tutorial/blob/master/file-templates-introduce.md

與上邊地址是一個作者,這個是目錄,我就是在這學習的 IDEA, 感覺寫的灰常不錯(文字與圖較多,文章學習起來可能花費的時間比較多)
https://github.com/judasn/IntelliJ-IDEA-Tutorial