IDEA自定義註釋

CodingSh1t發表於2024-03-06

註釋模板配置

  1. 首先開啟 IDEA 設定 Settings...(Windows 快捷鍵:Ctrl + Alt + S,Mac 快捷鍵:command + ,)---> Editor ---> Live Templates ---> 點選右側加號 "+"

  2. 設定以下六處相應的內容

  • Abbreviation:
    快捷縮略詞,可以輸入數值、字母、符號,到時配合 /* 使用(依模板內容而定),例如你輸入一個,那麼到時候輸入 / 回車即可,以下為本人設定內容 *

  • Description:
    實時模板的說明文字,提示顯示用

    java方法註釋快捷操作
    
  • Template text:
    模板內容,即自定義註釋展示內容

    *
     * -------------------------
     * @Description: 
     * @Author: codingSh1t
     * @Date: $date$ $param$ $return$
     * @UpdateLog: Description Author Date
     * -------------------------
     */
    
  • Options:
    其他引數,包括格式化、展開方式等

    Expand with選擇Enter,勾選Reformat according to style和Shorten FQ names
    
  • Change(第一次設定是Define):
    應用於哪個位置,由於此次操作為 Java,固只在 Java 前挑勾應用

    勾選Java下的Comment
    
  • Expand with:
    展開方式:預設選Enter就行

  • Edit variables:
    編輯變數按鈕,引數設定為:
    param:

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

    return:

    groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void') { stop=true; }; if(!stop) { result += '\\n'; result += ' * @return ' + data; }; return result;", methodReturnType())
    

    date:

    date("yyyy/MM/dd HH:mm")
    

相關文章