目錄

一、前言

一、前言

二、添加註釋

• 2.1 類頭註釋

        類頭註釋內容：

/**     
  * @description  //TODO 類描述
  * @author      Jackney
  * @date ${DATE} ${TIME} 
 */

2.1.1、建立類檔案自動新增

1. 設定路徑：選單欄 File->Settings…->Editor->File and Code Templates->Includes->File Header （如下圖）-->輸入註釋內容-->OK
2. 驗證：新建新類，在類上自動添加註釋內容

                                                                                                         類頭註釋圖

2.1.2、建立後快捷鍵新增

      設定路徑：

1. 選單欄 File->Settings…->Editor->Live Templates
2. 新增組：點選 右邊＋-->Template Group…-->輸入組名（可自定義，我這邊MyGroup）--OK(如圖)

       3.添加註釋:選擇新建立組-->點選右邊+-->Live Template-->如圖

• Abbreviation:在程式碼中新增該註釋模板的快捷鍵，在要新增的註釋內容下輸入快捷鍵按回車或Tap鍵
• Description:是該模板的描述
• Template text:具體的模板內容
• Edit varivables:模板中變數編輯
• No applicable contexts.Define:該模板應用的範圍

      4.新增模板

      5. 編輯變數：點選Edit variables-->在Expression輸入內容。

注意：Expression內容輸入結束後，按回車鍵才能儲存；

            Skip if defined:未勾選，生成註釋後焦點會顯示在該處待修改；（焦點從上到下切換）

       6.設定應用範圍：點選Define--勾選Everywhere--最終點選OK按鈕設定完畢

  驗證:在已建立的類中輸入cmt回車，能顯示註釋內容

2.2 方法添加註釋

方法註釋模板如下

/**
   * @description: //TODO 描述一下方法的作用
   *
  $param$
   * @return: $return$
   * @author: Jackney
   * @date:   $date$ $time$    
 */

新增方法同上，唯一不同的是，變數的設定不一樣。

param :Default value內容

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n\\b' : '')}; return result", methodParameters())

驗證：新增方法的註釋必須要在方法內輸入新增，否則param 和return的值會異常（圖下圖）；輸入mcmt回車或按Tab鍵即可。