Flutter添加方法注釋模板

在Android Studio(Mac端)中添加Dart的方法注釋模板。整體步驟是和設(shè)置JAVA一樣的,主要是模板幾個(gè)參數(shù)不太一樣。

1寞酿、設(shè)置路徑? Preferences — Editor — Live Templates

2、新建一個(gè) Live Templates

由于獲取? 參數(shù)脱柱、返回值伐弹、方法名等方法是用Dart獨(dú)有的,不適用于別的語言榨为,所以建議直接建在Dart 分組下惨好,這個(gè)也是Flutter方法注釋模板和別的主要區(qū)別

????????

3、配置 Live Templates

Abbreviation:? 模板縮寫 ?我用的是一個(gè)?? * 随闺,這個(gè)看個(gè)人習(xí)慣
Description: 模板的說明
Expand with:?? 展開模板的確認(rèn)鍵?? (默認(rèn)是tab?? 我用的是Enter回車日川,看個(gè)人習(xí)慣)
Template Text: ? 模板格式如下:(title:方法名????????description:方法說明 ? ? ??param:方法參數(shù),由于是動(dòng)態(tài)的所以沒有寫? @param矩乐,可能存在無參數(shù)的方法 ??? return:同參數(shù)一樣的原理 ??? updateTime:注釋添加的時(shí)間 ????author:作者名) 自己根據(jù)需要增刪

///@title $title$
///@description TODO $param$ $return$
///@updateTime $date$ $time$
///@author TongYu

這時(shí)候在下面會(huì)出現(xiàn) ??No applicable contexts. Define ? ? 點(diǎn)擊選擇 Dart 語言
變成了? Applicable in Dart xxxxxxxx. Change? 即可


還有重要的一步龄句,點(diǎn)擊按鈕? Edit variables :? 配置 模板里面的各個(gè)參數(shù)的值 回论。 ( 如$param$?? 在Template Text模板里面兩個(gè)$ 之間的字段,都會(huì)在這里面顯示)
title:? 方法名??? 選擇 dartMethodName()??? (其他語言類似分歇,比如java配置的時(shí)候選的是 methodName())
date:日期?????? date()
time:時(shí)間?????? time()
param:?? 參數(shù)???? 這個(gè)可以選擇??? dartMethodParameters()?? 這個(gè)方法返回的是一個(gè)數(shù)組傀蓉。( 如果直接使用這個(gè)方法的話?? 模板格式需要變動(dòng)芭届, $param$? 需要換行? 加個(gè) @param )????? 我是用的是一個(gè)腳本瘟仿,動(dòng)態(tài)拼接了一下,腳本如下暑劝,復(fù)制直接填入就行:

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:?? 返回值格式 ??? 這個(gè)可以選擇??? dartReturnType()? 返回的是一個(gè)數(shù)據(jù)格式? 原理同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())

??

4萨蚕、使用

????? 使用是 結(jié)合剛才配置的? ? 在方法內(nèi)使用?? Abbreviation (* 號(hào)) +?? Expand with (Enter) ??????? 即可自動(dòng)生成注釋模板

5靶草、注意

?????? 讓強(qiáng)迫癥難受的是? 這個(gè)只能在方法內(nèi)生成蹄胰,再Copy出去,如果直接在外面生成? 無法獲取到方法名稱奕翔、參數(shù)裕寨、返回值。
?????? 另外? 為什么不用? /**/ 這種注釋符號(hào)派继,是因?yàn)? dart會(huì)有提示 宾袜,文本的注釋 更提倡 ///?? 這個(gè)看自己眼緣,看不順眼的話可以改成/**/?? 需要改動(dòng)的地方有?? 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())

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末驾窟,一起剝皮案震驚了整個(gè)濱河市庆猫,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌绅络,老刑警劉巖月培,帶你破解...
    沈念sama閱讀 218,941評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異恩急,居然都是意外死亡杉畜,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,397評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門衷恭,熙熙樓的掌柜王于貴愁眉苦臉地迎上來此叠,“玉大人,你說我怎么就攤上這事随珠∶鹪” “怎么了?”我有些...
    開封第一講書人閱讀 165,345評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵窗看,是天一觀的道長茸歧。 經(jīng)常有香客問我,道長烤芦,這世上最難降的妖魔是什么举娩? 我笑而不...
    開封第一講書人閱讀 58,851評(píng)論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上铜涉,老公的妹妹穿的比我還像新娘智玻。我一直安慰自己,他們只是感情好芙代,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,868評(píng)論 6 392
  • 文/花漫 我一把揭開白布吊奢。 她就那樣靜靜地躺著,像睡著了一般纹烹。 火紅的嫁衣襯著肌膚如雪页滚。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,688評(píng)論 1 305
  • 那天铺呵,我揣著相機(jī)與錄音裹驰,去河邊找鬼。 笑死片挂,一個(gè)胖子當(dāng)著我的面吹牛幻林,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播音念,決...
    沈念sama閱讀 40,414評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼沪饺,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了闷愤?” 一聲冷哼從身側(cè)響起整葡,我...
    開封第一講書人閱讀 39,319評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎讥脐,沒想到半個(gè)月后遭居,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,775評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡攘烛,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評(píng)論 3 336
  • 正文 我和宋清朗相戀三年魏滚,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片坟漱。...
    茶點(diǎn)故事閱讀 40,096評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡鼠次,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出芋齿,到底是詐尸還是另有隱情腥寇,我是刑警寧澤,帶...
    沈念sama閱讀 35,789評(píng)論 5 346
  • 正文 年R本政府宣布觅捆,位于F島的核電站赦役,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏栅炒。R本人自食惡果不足惜掂摔,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,437評(píng)論 3 331
  • 文/蒙蒙 一术羔、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧乙漓,春花似錦级历、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,993評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至涩蜘,卻和暖如春嚼贡,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背同诫。 一陣腳步聲響...
    開封第一講書人閱讀 33,107評(píng)論 1 271
  • 我被黑心中介騙來泰國打工粤策, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人剩辟。 一個(gè)月前我還...
    沈念sama閱讀 48,308評(píng)論 3 372
  • 正文 我出身青樓掐场,卻偏偏與公主長得像往扔,于是被迫代替她去往敵國和親贩猎。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,037評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容