如何在Android studio中設(shè)置類注釋和方法注釋模板

類注釋
類注釋的設(shè)置相比來說較為簡單,首先使用快捷鍵ctrl+alt+s彈出Settings對話框,選擇Editor里面的File and Code Templates,在Includes里面選擇File Header選項(xiàng):


image.png

在右側(cè)的編輯框里面即可自定義自己想要呈現(xiàn)的注釋內(nèi)容,此處我只填寫了作者和日期:

/**

  • @author: ${USER}
  • @date: ${DATE}
    */
    1
    2
    3
    4
    這樣設(shè)置之后,每次新建類時便會自動顯示作者和當(dāng)前日期,當(dāng)然此處也可以添加其他內(nèi)容。

方法注釋
要想設(shè)置方法注釋,首先也是使用快捷鍵ctrl+alt+s,進(jìn)入Editor,此處選擇Live Templates選項(xiàng):


image.png

在彈出的選項(xiàng)框中點(diǎn)“+”選擇Template Group 新建Template Group為CustomTemplate(可以任意?。?/p>

image.png

image.png

點(diǎn)擊ok可以看到列表中新增了一項(xiàng)“CustomTemplate”,選中此項(xiàng),點(diǎn)擊“+”,選擇Live Template:
image.png

設(shè)置Abbreviation為cmt,這個為注釋的快捷鍵,當(dāng)在方法的上方輸入cmd時,即可出現(xiàn)注釋。當(dāng)然也可以任意設(shè)置為其他字符。隨后編輯在Template Text中的注釋模板:


image.png

此處我的設(shè)置如下,包括方法描述description ,參數(shù)param ,返回值類型return ,作者author ,時間time:

/**

  • @description desc
  • @param methodParameters
  • @return methodReturnType
  • @author user
  • @time date time
    */
    1
    2
    3
    4
    5
    6
    7
    隨后點(diǎn)擊Change,選擇Declaration,將其設(shè)置為注釋時顯示。
    image.png

點(diǎn)擊Edit variables,開始設(shè)置每個名稱的作用,如將name為user的表達(dá)式設(shè)置為user(),即可自動顯示作者名,date()自動顯示最新日期:

image.png

點(diǎn)擊ok,apply即可。
在java文件中的方法上輸入cmt即可出現(xiàn)設(shè)置模板,如下:


image.png

https://blog.csdn.net/u014390957/article/details/83113435

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容