IDEA 注釋模板設置


1.類注釋模板設置
IDEA --> Settings... --> Editor --> File and Code Templates --> Includes -->File Header

/**
*   ClassName:    ${NAME}
*   Package:    ${PACKAGE_NAME}
*   Description:
*   Datetime:    ${DATE}   ${TIME}
*   Author:   XXXXX@XX.com
*/

           

 2.方法注釋模板設置

IDEA --> Settings... --> Editor --> Live Templates  --> 點擊+號  -->Template Group...(添加模板組)

 添加了模板組后再次點擊+號,這次選擇Live Template(添加注釋模板)

  2.1    Abbreviation: 該處填入* (注意設置的模板名稱為*,此處一定要填寫*,因為IDEA生成注釋的默認方式是:/*+模板名+快捷鍵)

  2.2    Description:該處填入調用模板時的提示

  2.3    Tempate test內容(一定要以**開頭):

**
 * @Description    
 $params$
 $return$ 
 * @author  $author$a
 * @Datetime  $date$ $time$
 */   

  或者(推薦下面這種):

**
 * 功能描述:   <br/>
 * 創建時間:  $date$ $time$
 $params$
 $return$ 
 * @author  $author$
 */

        2.4    Edit variables:

  params Default value內容:

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

  return Default value內容:

groovyScript("def returnType = \"${_1}\"; def result = '* @return ' + returnType; return result;", methodReturnType());

  author、date、time處變量分別點擊,下拉后選擇user(),date(),time()

                

       2.5    Expand with處選擇Tab鍵補全,默認也是按Tab鍵補全(設置為Enter鍵,類屬性文檔注釋會有沖突)

                

  2.6    Change處選擇Java

                 

 流程預覽:

                

測試效果:

  方法上輸入/*后按Tab鍵自動補全

  

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM