自定義 Android Studio 註釋模板

Android Studio 配置註釋模板有兩種方式:

File and Code Templates

Live Templates

先來說 File and Code Templates:用來配置文件和代碼模板,即文件在創建的時候自動會按文件模板生成代碼註釋。

下面來演示一下如何自動生成 Java 類註釋。

依次打開下面這個菜單:

Editor > File and Code Templates > files

 

這裏面自帶了很多文件的註釋模板,但是需要自己設置,上圖 class 裏面的內容就是自帶的,看裏面這句代碼:

#parse("File Header.java")

這句代碼它指向 File Header。

 再依次打開下面這個菜單:

Editor > File and Code Templates > File Header

其實 Includes 就是前面 Files 模板裏面 parse 引用的片段而已。File Header 默認是空的,我們在裏面編輯模板即可,支持一些預定義的變量,如:DATE、TIME、USER 等,如上圖右下部分,圖示顯示不全,有興趣的可以打開編譯器自行查看。

配置完後,隨便創建一個類就會自動帶上註釋。如下圖:

模板:

/**   
 * @Description:    java類作用描述 
 * @Author:         作者名
 * @Email:          郵箱  
 * @CreateDate:     ${DATE} ${TIME}
 * @UpdateRemark:   更新說明:
 * @Version:        1.0
 * PS: You can change the world with code! Don't give up!
 */

接下來我們說說 Live Templates:配置動態模板,可以在指定位置使用縮寫字母自動生成註釋。

首先打開 Live Templates 菜單,創建方法自定義註釋:

 依照上圖我們發現右上角有個 + 號,點擊選擇 Live Template 添加一個動態模板,依次配置下面的內容。

abbreviation: 模板縮寫

Description: 模板描述

Template Text: 模板內容

如下圖所示:

按照下圖中的方式去關聯變量,Template Text 裏面美元符號包起來的是變量,需要點擊 Edit variable 按鈕來設置這些變量。

 接着就是設置模板使用的場景,如以下所示,點擊 Define 鏈接,設置該模板只能在 Java 語言下使用。

 模板:

*
 * description: $description$ 
 * version: 1.0 
 * createDate: $date$ $time$ 
 * author: 作者
 *
$params$
        * @return $return$
        */ 

注意:方法裏面的 params 變量需要用以下 Groovy 表達式來配置,否則無法獲取。

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n\\b' : '')}; return result", methodParameters()) 

類註釋和方法註釋配置一致,這裏就不在多說了。

推薦:巧用Live Template,不僅能提升AS開發效率,還能裝逼

參考:https://www.jianshu.com/p/812d06702437

          https://www.cnblogs.com/linfenghp/p/5561639.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章