Flutter 文件、類、方法添加註釋模板

原創

IIronMan

2021-11-20 06:38

文件添加註釋
類添加註釋
方法添加註釋

一、文件添加註釋

1.1、我們創建一個dart文件的時候希望有一些對文件的註釋說明，我們可以在 Android Studio的 Preferences -> Editor — File and Templates -> Dart File

1.2、具體的內容

/// FileName ${NAME}
///
/// @Author ${USER}
/// @Date ${DATE} ${TIME}
///
/// @Description TODO

1.3、效果如下圖

二、類添加註釋

2.1、在Preferences —> Editor —> Live Templates -> Dart

三、方法添加註釋

3.1、在Preferences —> Editor —> Live Templates -> Dart 點擊加號，選擇 Live Template
3.2、配置 Live Templates
Abbreviation: 模板縮寫我用的是一個 * ，這個看個人習慣
Description: 模板的說明
Expand with: 展開模板的確認鍵（默認是tab 我用的是Enter回車，看個人習慣）
Template Text: 模板格式如下：（title：方法名 description：方法說明 param：方法參數，由於是動態的所以沒有寫 @param，可能存在無參數的方法 return：同參數一樣的原理 updateTime：註釋添加的時間 author：作者名）自己根據需要增刪
```
///@title $title$
///@description TODO $param$ $return$
///@updateTime $date$ $time$
///@author JoanKing
```
我一般是隻保留：title、param、return，如下
```
///@title $title$
///@description TODO $param$ $return$
```
這時候在下面會出現 ⚠️No applicable contexts. Define 點擊選擇 Dart 語言變成了 Applicable in Dart xxxxxxxx. Change 即可
3.3、重要的一步，點擊按鈕 Edit variables : 配置模板裏面的各個參數的值。（如 $param$ 在Template Text模板裏面兩個$ 之間的字段，都會在這裏面顯示）
- title: 方法名選擇 dartMethodName() （其他語言類似，比如java配置的時候選的是 methodName()）
- date：日期 date()
- time：時間 time()
- param: 參數這個可以選擇 dartMethodParameters() 這個方法返回的是一個數組。（如果直接使用這個方法的話模板格式需要變動， $param$ 需要換行加個 @param ）我是用的是一個腳本，動態拼接了一下，腳本如下，複製直接填入就行：
  
  groovyScript("def result=''; def stop=false; def params="${_1}".replaceAll('[\\[|\\]|\\s]', '').split(',').toList(); if (params.size()==1 && (params[0]==null || params[0]=='null' || params[0]=='')) { stop=true; }; if(!stop) { for(i=0; i < params.size(); i++) {result +=((i==0) ? '\r\n' : '') + ((i < params.size() - 1) ? '///@param: ' + params[i] + '\r\n' : '///@param: ' + params[i] + '')}; }; return result;", dartMethodParameters())
- return: 返回值格式這個可以選擇 dartReturnType() 返回的是一個數據格式原理同param，腳本如下：
  
  groovyScript("def result=''; def data="${_1}"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\r\n' + '///@return: ' + data; }; return result;", dartReturnType())
3.4、使用

使用是結合剛纔配置的在方法內使用 Abbreviation (method) + Expand with （Enter）即可自動生成註釋模板
3.5、注意
提示：這個只能在方法內生成，再Copy出去，如果直接在外面生成無法獲取到方法名稱、參數、返回值。
另外爲什麼不用 // 這種註釋符號，是因爲 dart會有提示，文本的註釋更提倡 /// 這個看自己眼緣，看不順眼的話可以改成// 需要改動的地方有 Template Text: param:的腳本里面的拼接 return:的拼接如下：
Template Text:
/*
- @title $title$
- @description TODO $param$ $return$
- @updateTime $date$ $time$
- @author TongYu
  */
- param:
  groovyScript("def result=''; def stop=false; def params="${_1}".replaceAll('[\\[|\\]|\\s]','').split(',').toList(); if (params.size()==1 &&(params[0]==null || params[0]=='null' || params[0]=='')) { stop=true; };if(!stop) { for(i=0; i < params.size(); i++) {result +=((i==0) ?'\r\n' : '') + ((i < params.size() - 1) ? ' * @param: ' + params[i]+ '\r\n' : ' * @param: ' + params[i] + '')}; }; return result;",dartMethodParameters())
- return:
  groovyScript("def result=''; def data="${_1}"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true;}; if(!stop) { result += '\r\n' + ' * @return: ' + data; }; returnresult;", dartReturnType())
提示:(由於獲取參數、返回值、方法名等方法是用Dart獨有的，不適用於別的語言，所以建議直接建在Dart 分組下，這個也是Flutter方法註釋模板和別的主要區別)