在日常項(xiàng)目開發(fā)過程中铅碍，項(xiàng)目組都會(huì)有自己的一套默認(rèn)的注釋模板傻谁。這里书劝，我們介紹下如何在Intellj idea(由于Android Studio是基于idea的老充，配置是一樣的）中葡盗，修改默認(rèn)的注釋模板，以獲得我們想要的效果啡浊。文中將分別介紹

• 文件頭（File Header）的配置：在創(chuàng)建代碼文件時(shí)在文件頭生成
• 類的配置：在新建類文件時(shí)自動(dòng)生成觅够，其模板中會(huì)解析File Header文件中的內(nèi)容
• 方法的配置：配置好模板，根據(jù)快捷鍵生成

一巷嚣、配置File Header注釋模板

在打開的idea工程中喘先，選擇File->Setting->Editor->File and Code Templates，在打開的右側(cè)窗口中選取Includes頁(yè)簽下的File Header子項(xiàng)（若不存在該項(xiàng)廷粒，則新建一個(gè)）窘拯，如下所示：

• ${PACKAGE_NAME} 被創(chuàng)建新文件的包名搔涝。
• ${USER} 當(dāng)前用戶系統(tǒng)登陸名，這個(gè)名字可以在計(jì)算機(jī)->管理里面做修改和措。
• ${DATE} 當(dāng)前系統(tǒng)日期
• ${TIME}當(dāng)前系統(tǒng)時(shí)間
• ${YEAR}當(dāng)前年份
• ${MONTH} 當(dāng)前月份
• ${MONTH_NAME_SHORT}當(dāng)前月份名的前三個(gè)字母庄呈，比如，Jan派阱，F(xiàn)eb等
• ${MONTH_NAME_FULL} 當(dāng)前月份名的完整名稱诬留，比如，January, February等
• ${DAY} 月份的當(dāng)前天
• ${DAY_NAME_SHORT} 當(dāng)前天名的前三個(gè)字母贫母，比如文兑，Mon，Tue等
• ${DAY_NAME_FULL} 當(dāng)前天名的前三個(gè)字母腺劣，比如绿贞，Monday，Tuesday等
• ${HOUR} 當(dāng)前小時(shí)
• ${MINUTE} 當(dāng)前分鐘
• ${PROJECT_NAME} 當(dāng)前工程名
  通過以上橘原，我們可以知道籍铁，該文件會(huì)是其它模板文件的內(nèi)建模板，我們通持憾希可以使用其預(yù)定義的變量拒名。下面給出一個(gè)模板：

/**
 *  
 * @author: ${USER}
 * @description please add a description here
 * @date: Create in ${TIME} ${DATE}
 */

將以上內(nèi)容貼到編輯框中，然后點(diǎn)擊Apply或Ok按鈕芋酌。接著增显，新建一個(gè)文件后，可以看到如下的結(jié)果隔嫡。

/**
 * @author: killua
 * @description please add a description here
 * @date: Create in 20:20 2018/7/14
 */
public class Demo
{
}

這樣子甸怕，我們就完成了文件頭的配置。

二腮恩、配置類注釋模板

類模板的配置與文件頭大餓配置有點(diǎn)重復(fù)的感覺梢杭。如果已經(jīng)配置了文件頭后，就不需要再配置該模板了秸滴。該模板只針對(duì)所有的Class類武契。如果要為接口添加注釋，需要修改相應(yīng)的模板。
通過File->Setting->Editor->File and Code Templates咒唆，打開右側(cè)Files頁(yè)簽下的Class子項(xiàng)届垫，進(jìn)行配置。

三仿耽、配置方法模板

idea自帶了一個(gè)方法模板合冀，但只有param和return字段，不夠?qū)嵱孟詈兀缦滤荆?/p>

    /**
     *
     * @param param
     * @return
     */
    private boolean isShow(String param)
    {
        return true;
    }

通過在方法定義上一行中敲擊/** + Enter觸發(fā)模板君躺。
接著，我們來實(shí)現(xiàn)我們的自定義模板开缎，通過File-->Settings-->Editor-->Live Templates棕叫，然后點(diǎn)擊右上角的+，選擇Template Group來創(chuàng)建一個(gè)新的組奕删，取名為CustomGroup俺泣，如圖所示。

*
 *
 * @author $user$
 * @param $param$
 * @return $return$
 * @date $time$ $date$
 **/

設(shè)置參數(shù)名時(shí)必須用${參數(shù)名}$的方式踊跟，為了獲取param和return的參數(shù)踩验，idea提供了內(nèi)置的幾個(gè)方法：

• param通過methodParameters()來獲取
• return 通過methodReturnType()來獲取
• time 通過time()來獲取
• date 通過date()來獲取
• user 通過user()來獲取
  通過點(diǎn)擊Edit Variables來設(shè)置相應(yīng)的參數(shù)值，如下所示：
  
  
  
  
  最后琴锭，修改idea默認(rèn)的快捷鍵晰甚，將tab改為Enter，如下圖所示决帖。
  
  
  這樣子就完成了方法注釋模板的編輯，新建方法后蓖捶，敲擊* + Enter后地回，效果如下。

    /**
     *
     * @author killua
     * @param [`param1`, parm2]
     * @return
     * @date 12:24 2018/7/15
     **/

但代碼檢測(cè)工具會(huì)對(duì)參數(shù)以紅色告警方式顯示俊鱼，這是因?yàn)樗也坏?code>[param1, parm2]參數(shù)刻像。
如果要顯示參數(shù)列表單獨(dú)顯示那種方式（自帶那種方式），只能在方法內(nèi)部實(shí)現(xiàn)并闲，這時(shí)候需要將配置的methodParameters()替換為以下腳本:

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())*

方法內(nèi)和外的效果對(duì)比细睡，方法外無法獲取參數(shù)列表

/**
     *
     * @author killua
     * @param null
     * @return 
     * @date 12:22 2018/7/15
     **/
    private boolean isShow(String param1, String parm2)
    {
        /**
         *
         * @author killua
         * @param param1
         * @param parm2
         * @return 
         * @date 12:22 2018/7/15
         **/
        return true;
    }

這幾種方式都不算好，因?yàn)镮ntellj idea的/** + Enter不算一個(gè)Live Template帝火。這里有個(gè)折中的方案溜徙，就是同時(shí)利用了自帶的/** + Enter和新建的Live Template。并在新建模板中添加你額外的屬性犀填，如下所示：

@author $USER$ 
    * @since  $DATE$;

然后蠢壹，先敲擊自帶的功能/** + Enter，然后繼續(xù)在注釋中敲擊auth+Enter獲取完整的信息九巡，如下：

  /**
     * 
     * @param param1
     * @param parm2
     * @author killua
     * @since 2018/7/15;
     * @return
     */
    private boolean isShow(String param1, String parm2)
    {
        return true;
    }