公司有統一代碼註釋 - 類和方法註釋模板

類註釋

圖1 idea默認的類模板

無論能不能懂 VTL 語法，當看到這裏#parse("File Header.java")應該就知道它包含了另外一個文件。沒錯，文件在這：

圖2 File Header.java

那咱們該怎麼修改呢？分狀況吧

1. 只想修改Class下的模板，那就刪除圖1中#parse("File Header.java")，添加新的註釋進去。（推薦）

   /**
    * ${DESCRIPTION}
    * @author
    * @create ${YEAR}-${MONTH}-${DAY} ${TIME}
    */

   ${DESCRIPTION} 是咱們本身定義的變量，自定義變量格式有兩種方式：$變量名 或 ${變量名}，自定義的變量在建立對應的文件時候就必須輸入內容

2. 想修改全部引用了File Header.java 的文件模板，修改圖2以下。

   /**
    * @author
    * @create ${YEAR}-${MONTH}-${DAY} ${TIME}
    */

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

• ${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.

方法註釋

idea的方法註釋通常經過Live Templates實現

這塊內容不瞭解的能夠戳進

1. 添加Live Templates

2. 輸入Abbreviation，你能夠鍵入之獲取 Template text中的內容

3. 在Template text中鍵入

   /**
   * @Description:  
   * @author: $user$  
   * @Param: $params$
   * @Return: $return$
   * @Date: $date$ $time$
   */

   其中，$$之間的是自定義變量，能夠經過Edit variables設置

4. 設置applicable contexts

5. 勾選 Reformat according to style

6. 設置變量的值

   點擊Edit variables，進入後選擇每一個變量對應的Expression

7. 使用

   這種方式須要獲取方法的相關信息，因此須在方法內部鍵入Abbreviation，若是在方法外部使用，將出現獲取不到值的狀況