1. IDEA註釋模板使用

1. 匯入檔案setting.zip

   • 檔案下載地址

     連結：https://pan.baidu.com/s/133g7UJQeLE_gebrMHg6-yw
     提取碼：b4r9

   • Idea匯入方式

     路徑 FIle ->Manage IDE Settings ->Import Settings

2. 使用

   • 類註釋

     • 建立類時自動增加註釋
     • 輸入 /* + Tab 可以自動出現註釋
     • 註釋demo如下：TODO為需要修改的類描述符

     /**
      * TODO
      * @author steven
      * @date 2021/12/30 15:22
      * @version 1.0
      */
      
     

   • 方式註釋

     • 在方法上輸入 /** + Tab 可以自動出現註釋

     • 註釋demo如下：TODO為需要修改的類描述，這個存在一個問題，return 後面如果是List,會有一個空格，沒有找到解決方案

       /** 
          * TODO
          * @param ddlQuestionId
          * @param ksDdlSetting 
          * @return {@link List< QuestionES>}
          * @author steven
          * @date 2021/12/30 18:06
          */ 
       

2. IDEA 註釋修改方法

2.1 建立類時自動新增類註釋

1. 進入類註釋修改頁面：FIle -> Settings ->Editor -> File and Code Templates -> Class

2. 增加上面的註釋後點擊儲存按鈕

   /**
    * TODO 
    * @author ${USER}
    * @date ${DATE} ${TIME}
    * @version 1.0
    */
   

2.2 通過字首添加註釋

1. 進入類註釋修改頁面：FIle -> Settings ->Editor -> Live Templates

2. 可以看到我這裡添加了kp-java-template組，以及兩個縮寫 *以及**。這裡不要在前面加 /,否則註釋會出問題

3. * 類上註解

   **
    * TODO
    * @author $user$
    * @date $date$ $time$
    * @version 1.0
    */
    
   

   上面的內容有很多的變數，所以我們需要點選Edit variables指定變數的值

4. ** 方法上註解

** 
 * TODO
 $params$ 
 $returns$
 * @author $USER$
 * @date $date$ $time$
 */ 

同樣，這裡也有變數需要為變數賦值

可以看到我們對params,returns做了特殊處理，這裡是groovy指令碼，有興趣的可以改進一下

• params 指令碼

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

• returns 指令碼

  groovyScript("return \"${_1}\" == 'void' ? '' : '* @return {@link ' +\"${_1}\" + '}'", methodReturnType())
  

3. 匯出自己的配置給別人用

如果覺得自己的配置很好，可以修改之後匯出自己的配置給別人使用

選擇註釋相關文件即可