目錄

• 文件添加注釋
• 類添加注釋
• 方法添加注釋

一涡真、文件添加注釋

• 1.1、我們創(chuàng)建一個(gè)dart文件的時(shí)候希望有一些對(duì)文件的注釋說明肾筐，我們可以在 Android Studio的 Preferences -> Editor — File and Templates -> Dart File

  
  
  dart文件添加注釋

• 1.2哆料、具體的內(nèi)容

  /// 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 點(diǎn)擊加號(hào)典阵，選擇 Live Template

• 3.2、配置 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ù)需要增刪

  /// method_name $title$
  /// author JoanKing
  /// description TODO 
  /// $param$ $return$
  

  我一般是只保留：title歹啼、param、return座菠，如下

  /// method_name $title$
  /// description TODO 
  /// $param$  $return$
  

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

  
  

• 3.3狸眼、重要的一步，點(diǎn)擊按鈕 Edit variables : 配置 模板里面的各個(gè)參數(shù)的值 浴滴。 （ 如 在Template Text模板里面兩個(gè)$ 之間的字段拓萌，都會(huì)在這里面顯示）

  • title: 方法名 選擇 dartMethodName() （其他語言類似，比如java配置的時(shí)候選的是 methodName()）
  • date：日期 date()
  • time：時(shí)間 time()
  • param: 參數(shù) 這個(gè)可以選擇 dartMethodParameters() 這個(gè)方法返回的是一個(gè)數(shù)組巡莹。（ 如果直接使用這個(gè)方法的話 模板格式需要變動(dòng)司志， 需要換行 加個(gè) @param ） 我是用的是一個(gè)腳本，動(dòng)態(tài)拼接了一下降宅，腳本如下骂远，復(fù)制直接填入就行：

    • @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())
    • [] 版本
      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) ? '/// ' + '[' + params[i] + ']' + '\r\n' : '/// ' + '[' + params[i] + ']' + '')}; }; return result;", dartMethodParameters())

  • return: 返回值格式 這個(gè)可以選擇 dartReturnType() 返回的是一個(gè)數(shù)據(jù)格式 原理同param，腳本如下：

    • @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())

    • [] 版本
      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腰根、使用
  使用是 結(jié)合剛才配置的 在方法內(nèi)使用 Abbreviation (method) + Expand with （Enter） 即可自動(dòng)生成注釋模板
  

  效果

• 3.5激才、注意
  提示： 這個(gè)只能在方法內(nèi)生成，再Copy出去，如果直接在外面生成 無法獲取到方法名稱瘸恼、參數(shù)劣挫、返回值。
  另外 為什么不用 // 這種注釋符號(hào)东帅，是因?yàn)? dart會(huì)有提示 压固，文本的注釋 更提倡 /// 這個(gè)看自己眼緣，看不順眼的話可以改成// 需要改動(dòng)的地方有 Template Text: param:的腳本里面的拼接 return:的拼接 如下：

  Template Text:
  /*

  • @title
  • @description TODO
  • @updateTime
  • @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())

• 提示:(由于獲取 參數(shù)靠闭、返回值帐我、方法名等方法是用Dart獨(dú)有的，不適用于別的語言愧膀，所以建議直接建在Dart 分組下拦键，這個(gè)也是Flutter方法注釋模板和別的主要區(qū)別)