Android Studio技巧 之 自動(dòng)生成類描述

在IT行業(yè)中,項(xiàng)目的開發(fā)過程,往往是需要多個(gè)人一起合作開發(fā),或者是去維護(hù)他人的舊代碼,可是這樣就會(huì)導(dǎo)致每次去查看別人編寫的類,并且需要了解清楚類的作用時(shí),這樣是很耗時(shí)間的;當(dāng)然,如果上一個(gè)開發(fā)人員有時(shí)間給你留下一份開發(fā)文檔或者源碼說明文檔,這樣很省時(shí)間,不過這個(gè)是理想狀態(tài)啊,目前在國內(nèi),特別是小公司,一個(gè)項(xiàng)目的開發(fā)時(shí)間,已經(jīng)是被嚴(yán)重的壓縮,需求的實(shí)現(xiàn)可能都不夠時(shí)間,就更加別想,別人會(huì)給你留下開發(fā)文檔或者源碼說明文檔了。

所以,開發(fā)文檔什么的,咱們可能是沒時(shí)間寫了,不過,我們可以使用另外的一種模式來替代啊;

就是,在開發(fā)過程中,我們每新建一個(gè)類,可以在類的頭部上或者方法的,添加一些簡(jiǎn)單的說明,描述當(dāng)前類的作用,如:


image.png

這樣簡(jiǎn)單的描述使得,不管是以后自己回來看此類,或者是別人接受維護(hù)你的代碼時(shí)都能快速的了解此類的作用。

但是作為程序猿,我們就是要能偷懶就要偷懶的啊,每次建一個(gè)類,都需要這樣描述,我也覺得煩躁啊。

So...

其實(shí),類的頭文件(類描述),我們可以使用開發(fā)工具 Android Studio來給我們自動(dòng)生成一個(gè)頭部文件模板:

image.png

至于,具體如何設(shè)置,參考些圖:

image.png

步驟

    1. 打開android studio設(shè)置面板(Ctrl + Alt + S)
    1. 輸入搜索: file and code templates
  • 3.選中 Includes下面的 File Header
    1. 填入模板,如下:
/**
 * @author gmf (可以寫固定的名稱或者使用計(jì)算機(jī)用戶名  ${USER})
 * @description 
 * @date ${DATE}.
 */

至此,就可以設(shè)置,每次新建一個(gè)類,都會(huì)自動(dòng)生成固定的模塊,再由我們自己添加幾句簡(jiǎn)單的描述即可。

有工具用,程序猿就該發(fā)揮工具的最大作用。一個(gè)簡(jiǎn)簡(jiǎn)單單的設(shè)置,滿足我們的需求。

最后編輯于
?著作權(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)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

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

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 179,220評(píng)論 25 708
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,657評(píng)論 19 139
  • 文:七月之上 1989年,J.M.畢曉普發(fā)現(xiàn)動(dòng)物腫瘤病毒的致癌基因,即原癌基因。 2008年,哈拉爾德.楚爾.豪森...
    七月之上閱讀 553評(píng)論 0 4
  • 最近在項(xiàng)目中使用android原生的Spinner發(fā)現(xiàn)其顯示效果沒有想象中的好,于是就動(dòng)手寫了一個(gè)popuwind...
    zj_King閱讀 13,328評(píng)論 1 9
  • 有人的生命是一條路 越走越寬 有人的生命是一炷香 越燒越短
    DDZSC閱讀 110評(píng)論 0 0

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