最近閒着沒事，看項目的時候有人問我Android Studio新建類如何自動添加頭部註釋、如何添加函數註釋等。至於爲什麼要添加註釋？因爲默認的註釋有時候看起來覺得很糟心，當然，這是玩笑話。有些公司入職的時候就會要求配置這些註釋模板，可以記錄一些修改的日誌，或者有些是直接給你jar包，直接導入到設置裏面就可以，這個其實很簡單。而且阿里的java代碼規範中也有寫道，所有的類都必須添加創建者信息。團隊協作中，這種代碼註釋顯得非常重要，知道是誰寫的，知道該找誰，這也是爲了代碼的乾淨整潔，排版漂亮。去一個新公司的時候，接手一個項目，裏面有沒有註釋，這對我們很重要，但是也有一種情況例外，就是你的代碼寫得非常好了，這種情況下就不用在寫註釋了，因爲你的代碼就是最好的註釋，不過這很難。下面就讓我們來看一下是怎麼實現的？
一、新建類自動添加頭部註釋
首先來看第一種情況，也是最簡單的情況，公司直接給你jar包，那麼就可以直接按照以下的流程來操作：
1、打開Android Studio，選擇File–>Import Settings–>找到jar包，導入Android Studio即可。如下圖所示：
第二種情況，就是需要自己去手動設置了，操作流程如下：
1、打開Android Studio，選擇File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header，如下圖所示：
輸入框中的內容可以自己設置，也可以讓同事複製一份發給你，直接粘貼就可以了。如果不知道怎麼寫的，想要了解一下，可以參考一下注釋下方的描述，如下圖所示：
其中，模板內容如下：
/**
*
* 主要功能:
* @Description:
* @Project: ${PROJECT_NAME}
* @Package: ${PACKAGE_NAME}
* @author: ${USER}
* @Email:
* @date: ${YEAR}年${MONTH}月${DAY}日 ${TIME}
* @Copyright: 個人版權所有
* @Company:
* @version: 1.0.0
* @Modify date and time:
* @Modified by:
* @Modified remark:
*/
看下Android Studio給出的描述信息吧：
這是一個內建的模板。它包含了一個通過#parse指令，可被文件模板包含的代碼片段。該模板是可編輯的。與靜態文本，代碼和註釋一起，你也可以使用預定義變量，然後它們將像宏一樣展開爲相應的值。
- ${PACKAGE_NAME} 被創建新文件的包名。
- ${USER} 當前用戶系統登陸名，這個名字可以在計算機->管理裏面做修改。
- ${DATE} 當前系統日期
- ${TIME}當前系統時間
- ${YEAR}當前年份
- ${MONTH} 當前月份
- ${MONTH_NAME_SHORT}當前月份名的前三個字母，比如，Jan，Feb等
- ${MONTH_NAME_FULL} 當前月份名的完整名稱，比如，January, February等
- ${DAY} 月份的當前天
- ${DAY_NAME_SHORT} 當前天名的前三個字母，比如，Mon，Tue等
- ${DAY_NAME_FULL} 當前天名的前三個字母，比如，Monday，Tuesday等
- ${HOUR} 當前小時
- ${MINUTE} 當前分鐘
- ${PROJECT_NAME} 當前工程名
通過以上，我們可以知道，該文件會是其它模板文件的內建模板，我們通常可以使用其預定義的變量
二、添加頭部註釋和函數註釋模板以及快捷鍵
1、打開Android Studio，選擇File–>Settings–>Editor–>Live Templates–>Templates Group，如下圖所示：
點擊新建組名之後，隨便輸入一個名字即可。
2、選擇自己新建的Group，然後點擊創建模板，如下圖所示：
3、輸入你要創建的模板名稱，還有描述，需要顯示內容，以及更改所需的快捷鍵，如下圖所示：
其中，模板內容如下：
/**
*
* 主要功能:
* @Description: $des$
* @Project: $PROJECT_NAME$
* @Package: $PACKAGE_NAME$
* @author: $USER$
* @date: $YEAR$年$MONTH$月$DAY$日 $TIME$
* @Copyright: 個人版權所有
* @Company:
* @version: $
*/
注意：設置參數名時必須用$ {參數名}$的方式，爲了獲取param和return的參數，Android Studio提供了內置的幾個方法：
- Package通過currentPackage()來獲取
- param通過methodParameters()來獲取
- return 通過methodReturnType()來獲取
- time 通過time()來獲取
- date 通過date()來獲取
- user 通過user()來獲取
。。。。。 等等，還有其他一些，這裏就不展開介紹了。
4、點擊Edit variables後，需要對你所定義的變量進行賦值，彈出界面如下圖所示：
![在這裏插入圖片描述]()
5、設置快捷鍵生效位置：在聲明的時候生效，即你在函數名上面輸入自定義的類名加回車，如下圖所示：
![在這裏插入圖片描述]()
注意：記得將默認的快捷鍵Tab改爲Enter，如下圖所示：
![在這裏插入圖片描述]()
6、然後使用的時候只需要在類名的前面，輸入自己定義類模板名稱，然後回車(Enter)即可，如下圖所示：
函數模板也是一樣的，只不過在使用的時候是在函數名前面使用而已，但是使用之後你會發現函數註釋模板並不能自動生成函數參數，感覺上不如系統自帶的好用，這裏我們能想到的辦法就是利用自帶的/** + Enter和新建的Live Template組合起來使用，然後在新建模板中添加你額外所需要的屬性。如下圖所示：
注意空格：
* @Description:
* @Enclosing_Method: $methodName$
* @Written by: $user$
* @Creation Date: $date$ $time$
* @version: v1.0.0
然後，先敲擊自帶的功能/** + Enter，然後繼續在註釋中敲擊author+Enter獲取完整的信息，如下圖所示：
轉載自：https://blog.csdn.net/u014727709/article/details/103807764
歡迎start，歡迎評論，歡迎指正