Android stuido 注釋設(shè)置與使用

相信越來(lái)越多的小伙伴在使用AS了,養(yǎng)成一個(gè)規(guī)范的代碼風(fēng)格也是很重要的。

1.設(shè)置文件注釋

1.File->Setting->Editor

我們可以在文件模板中新建一個(gè)文件模板

上圖代碼:

```

*? Author:? ${USER}

*? Date:? ${DATE}

*? FileName:? ${NAME}.java

*? History:

* 1.? Date:${DATE} ${TIME}

* ? ? Author:${USER}

*? ? Modification:

*/

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

#parse("File Header.java")

public class ${NAME} {

}

```

然后新建類kind選擇BaseClass就可以了。

2.設(shè)置方法注釋

1.File->Setting->Editor->Live Templates

2.點(diǎn)擊+,創(chuàng)建一個(gè)Template Group

3.選中你剛剛創(chuàng)建的group,創(chuàng)建Live Template

4.填寫(xiě)Abbreviation,我這里填的是cmt,也即你這個(gè)注釋的快捷方式,你敲cmt加回車,模板就出來(lái)了

代碼如下

```

/**

*? @function:$methodName$

*? @description: $desc$

*? @param:$methodParameters$

*? @return:$methodReturnType$

*? @history:

*1.date:$date$ $time$

*? ? ? ? ? author:$user$

*? ? ? ? ? modification:

*/

```

5.要設(shè)置你這個(gè)cmt快捷鍵在哪里生效,我的選擇是在聲明的時(shí)候生效,也即你在方法名上打cmt加回車就可以了


6.注意到,我的Template text有定義了三個(gè)變量 desc,date,time,user,后面兩個(gè)我要生成日期和時(shí)間,作者,所以我們要編輯這三個(gè)變量

點(diǎn)擊Edit variables,在彈窗里分別為date,time 和user就是設(shè)置對(duì)應(yīng)的方法,date()這個(gè)方法會(huì)生成日期,time()這個(gè)方法會(huì)生成時(shí)間,user()會(huì)生成author

7.點(diǎn)擊Apply一切完成?,F(xiàn)在,你只要在方法名上敲上cmt回車,就會(huì)自動(dòng)生成注釋模板了,時(shí)間是自動(dòng)生成的

studio也有設(shè)置注釋快捷鍵

選擇fix dox comment然后就可以自定義了,趕緊試試吧

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

相關(guān)閱讀更多精彩內(nèi)容

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