Idea 添加註釋：類註釋、方法註釋

• 類註釋
• 方法註釋

類註釋

• File–Setting–Editor–File and Code Templates–Class:
  • 註釋模板：

    /**
     *
     *
     *@description: 
     *@author: Andy
     *@time: ${DATE} ${TIME}
     * 
     */
    

  • 操作截圖：
    
  • 效果：
    

方法註釋

• 為了獲取引數資訊，我們需要使用 “ Live Templates” 。

• 建立 Live Templates 分組

  • File–Setting–Live Templates。
    
    

• 建立 Template

  • 我們上一步建立了 Andy 分組，現在我們將在 Andy 分組中建立 Template。
    
  • 設定模板內容
    • 模板縮寫（Abbreviation）：例如，我們可以把它設定為 “a”。
    • 模板描述（Description）：例如，我們可以設定為 “方法註釋”。
    • 模板內容：

      /**
       *
       *
       * @description: 
      $params$
       * @return: $return$
       * @author: Andy
       * @time: $date$ $time$
       */    
      

      
    • 定義模板內容中引用的變數
      • 我們上一步的截圖中，點選 Edit variables 按鈕可以彈出變數設定視窗。
      • 這裡，我們把引數變數 params 設定為一個自定義函式 groovyScript() 。groovyScript 函式呼叫 Idea 的 methodParameters() 函式獲得引數陣列，並進行格式化。
        • params 的值（即 groovyScript 函式）：

          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' : '')}; return result", methodParameters())
          

      • 其他變數的值，直接使用 Idea 的函式進行賦值。
        • date → date()
        • time → time()
        • return → methodReturnType()
      • 
    • 定義模板的使用範圍
      
      
  • 效果：