IntelliJ IDEA 類代碼模板註解自定義

本篇內容爲你們提供的是IntelliJ IDEA 使用教程中的文件代碼模板的使用，IntelliJ IDEA是java語言開發的集成環境，IntelliJ在業界被公認爲最好的java開發工具之一，尤爲在智能代碼助手、代碼自動提示、重構、J2EE支持、Ant、JUnit、CVS整合、代碼審查、 創新的GUI設計等方面的功能能夠說是超常的。 。感興趣的同窗能夠參考學習下，具體內容以下：

文件代碼模板的介紹

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

• 如上圖 Gif 所示，IntelliJ IDEA 默認新建類自帶的類註釋格式通常不夠友好或是規範，因此咱們通常須要本身根據公司編碼規範進行設置。

• 如上圖 Gif 所示，這是根據我本身的需求進行設置的類註釋，這種註釋方式會更友好。

根據演示咱們應該已經很好地理解了文件代碼模板是什麼東西了。對此咱們能夠衍生出不少玩法，好比：咱們的項目 Controller、Service、Dao 等經常使用新對象都是要各自繼承某個類、實現某些接口或預設某些方法，也均可以經過這樣的文件代碼模板來實現。

• 官網介紹：https://www.jetbrains.com/idea/help/file-and-code-templates.html

文件代碼模板的設置

• 如上圖標註 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 對被修改的預設文件代碼模板，還原到默認狀態。

• 如上圖標註 1 所示，IntelliJ IDEA 還支持其餘常見會新建的文件類型，基本上咱們根本不用擔憂有不支持的文件類型，經常使用的基本都被涵蓋了。

• 如上圖標註 1 所示，該 File Header 文件就是前面 Java 文件代碼模板中引入語句中 #parse("File Header.java") 文件。

 

• 如上圖標註箭頭所示，${DESCRIPTION} 是咱們本身定義的變量，自定義變量格式有兩種方式：$變量名 或 ${變量名}。
• 自定義的變量在建立對應的文件時候就必須輸入內容，這個在本文最上面的 Gif 演示中已經有體現了。

• 如上圖 Gif 所示，當咱們須要用到一個固定值的自定義變量的時候而且該變量多個地方被引用，咱們能夠經過 VTL 語法的#set( $變量名 = "變量值內容" ); 來設置。

• 由於 Code 模塊改動的人很少，因此放在最後。咱們是沒法新建、刪除 Code 裏面的代碼模板。
• 如上圖標註 1 所示，在咱們經過快捷方式生成某個類的測試方法時候會自動調用此 Code 模板，因此咱們能夠解釋該 Code 功能主要用在 IntelliJ IDEA 自動幫咱們生成某些代碼的時候引用的模板。

文件代碼模板預設的變量

由於變量的命名太明瞭不過了，因此這裏很少講解，直接貼出官網的英文解釋：

• ${PACKAGE_NAME} - the name of the target package where the new class or interface will be created.
• ${PROJECT_NAME} - the name of the current project.
• ${FILE_NAME} - the name of the PHP file that will be created.
• ${NAME} - the name of the new file which you specify in the New File dialog box during the file creation.
• ${USER} - the login name of the current user.
• ${DATE} - the current system date.
• ${TIME} - the current system time.
• ${YEAR} - the current year.
• ${MONTH} - the current month.
• ${DAY} - the current day of the month.
• ${HOUR} - the current hour.
• ${MINUTE} - the current minute.
• ${PRODUCT_NAME} - the name of the IDE in which the file will be created.
• ${MONTH_NAME_SHORT} - the first 3 letters of the month name. Example: Jan, Feb, etc.
• ${MONTH_NAME_FULL} - full name of a month. Example: January, February, etc.

PHP 的文件類型預設的變量比上面的還多一點，具體能夠查閱官網：

• 官網變量介紹：https://www.jetbrains.com/idea/help/file-template-variables.html

後續有不少開發填坑的文章發佈，若是對你有幫助，請支持和加關注一下

http://e22a.com/h.05ApkG?cv=AAKHZXVo&sm=339944

https://shop119727980.taobao.com/?spm=0.0.0.0