1. 程式人生 > >Android Studio 中兩種方式定製自己的程式碼註釋頭

Android Studio 中兩種方式定製自己的程式碼註釋頭

在使用Android Studio的時候,每當新建立一個Java檔案的時候,系統會自動幫我們生成一個檔案註釋頭,類似

/***

*Create By SomeOne  On 2017/03/30 

**/

這樣的檔案頭註釋風格,可能有的人覺得這太普通,而且資訊量太少了,有沒有辦法展示更多的資訊量呢,比如包名類名,公司或者組織資訊等?毫無疑問,肯定是有辦法來滿足各位看官的,下面我這個菜鳥帶大家來實踐一下。

第一種情況:直接修改File Header來實現(系統預設會載入這裡的內容)

修改File Header可以實現定製自己的檔案註釋頭,因為系統會預設載入這裡的檔案,下面看下具體的操作步驟和實現效果


右側綠色字型的就是我們自己編寫的註釋模板了,可以看到我給每個Java檔案增加了包名,類名建立時間和作者,以及郵箱和組織機構等標籤,你們也可以自己建立更多的標籤(前面可以不用@符號),後面的美元符號跟的是對包名型別的引用,具體可以參照描述框的描述


修改好了之後記得Apply,並選擇OK儲存

下面看下具體的效果


新建一個Java類,你會發現神奇的事情發生了


你可以看到,Java檔案的頭部註釋變成了我們定義的模板,包含類名,包名,建立時間,作者,Email和組織名稱,請原諒我打了那麼多的馬賽克偷笑偷笑偷笑,不過效果是槓槓滴,可以看到包名和類名,以及日期時間都被替換成了當前檔案的資訊,這就是引用的魅力,哈哈生氣,不小心暴露的時間,是的愚人節後的一天,大好的清明假期,陽光明媚,而作為單身狗的我還在公司無聊的寫博文。大哭

第二種情況:定製動態Templates(推薦使用)

第一種情況雖然達到了我們想要的效果,但是不通用,某種情況下:比如你定製了含有組織機構和公司資訊的File Header的時候,每當建立一個Java檔案的時候系統都會幫你自動的生成這些模板檔案,某些情況下你並不需要這些資訊,比如你自己寫的Demo並不想打上公司的標籤,其實這個時候你可以手動刪除有關公司資訊的那一條,其實也不難,直接滑鼠定位到那一行,然後快捷鍵 Ctrl + Y (刪除行),這樣使用也沒問題,但是有一天你接了另一個公司的專案,而且需要你把程式碼打上另一個公司的標籤,難道你要一行一行的刪除然後在每個檔案中逐條新增資訊嗎?肯定不會,如果偷懶的程式設計師肯定會想著回去改下File Header 檔案的模板,這個是可以的,那如果下次又有這樣的情況發生呢?是不是要瘋了得意

 , 那有沒有更好的解決辦法呢?我認為是可以解決這些衝突的,就是要靈活的運用Templates

下面看下具體的操作步驟:


回到Java檔案中,輸入headFile(自定義的提示輸入文字)


看下效果,兩個都能生成類似的註釋頭,下面你可以哪裡不要刪哪裡大笑,如果有更多的公司,你需要定製更多的動態面板檔案模板,可以分別取名head_01 head_02 …… head_n 等等


好了,演示效果到此結束,謝謝大家捧場,我得去吃點東西了,注意執行環境是Android Studio。