快捷導(dǎo)航

解決阿里代碼規(guī)范檢測(cè)中方法缺少javadoc注釋的問(wèn)題

更新時(shí)間：2020年08月10日 09:26:31 作者：謝康立

這篇文章主要介紹了解決阿里代碼規(guī)范檢測(cè)中方法缺少javadoc注釋的問(wèn)題，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

一、問(wèn)題描述

安裝了阿里代碼檢測(cè)的插件后，敲一個(gè)簡(jiǎn)單的方法，發(fā)現(xiàn)提示有問(wèn)題，如下

/**
 * 查找User的集合
 */
  List<User> findAll();

提示信息為：

方法【findAll】缺少javadoc注釋

進(jìn)一步查看完整文檔里面關(guān)于方法注釋的規(guī)范為

所有的抽象方法（包括接口中的方法）必須要用javadoc注釋、除了返回值、參數(shù)、異常說(shuō)明外，還必須指出該方法做什么事情，實(shí)現(xiàn)什么功能。 說(shuō)明：如有實(shí)現(xiàn)和調(diào)用注意事項(xiàng)，請(qǐng)一并說(shuō)明。
  /**
   * fetch data by rule id
   * 
   * @param ruleId rule id
   * @param page page number
   * @param jsonContext json format context
   * @return Result<XxxxDO>
   */
  Result<XxxxDO> fetchDataByRuleId(Long ruleId, Integer page, String jsonContext);

二、問(wèn)題分析

從阿里提供的代碼規(guī)范我們可以知道以下信息：

1.要包含方法說(shuō)明
2.要包含參數(shù)列表
3.要包含返回值類型
4.要嚴(yán)格注意注釋的縮進(jìn)和星號(hào)數(shù)量

而關(guān)于日期、作者、時(shí)間這些并沒(méi)有做要求

所以我們可以通過(guò)添加模板的方法，來(lái)實(shí)現(xiàn)自動(dòng)注釋，避免警告

這里以IDEA為例

三、解決問(wèn)題

點(diǎn)擊 File - Settings... - Editor - Live Templates

點(diǎn)擊右邊的 + 號(hào)，選擇Template Group...來(lái)新建一個(gè)模板組

輸入模板組的名稱，這里以myJava為例，然后在模板組下點(diǎn)擊+號(hào)Live Template

注釋文本如下，可以直接復(fù)制，除了必要的參數(shù)列表和返回值后，你還可以自定義方法名、作者、日期等等，這里不再贅述

/**
 * description:
 * @Param $PARAMS$
 $RETURN$
 */

點(diǎn)擊Edit variables，一定要記得把勾都選上，return的值可以在下拉菜單找到，而Params的值請(qǐng)復(fù)制以下表達(dá)式

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' : '')}; 
      return result ", methodParameters())

點(diǎn)擊Apply或者ok，就大功告成了！

四、使用方法

編寫(xiě)完方法后在方法上面輸入/*，再按TAB鍵就會(huì)自動(dòng)生成模板，然后在第一行輸入方法描述就符合規(guī)范啦！

注意事項(xiàng)：官方文檔中要求@參數(shù)需要小寫(xiě)，如果寫(xiě)成了@Return就是錯(cuò)誤的，應(yīng)該寫(xiě)成@return

到此這篇關(guān)于解決阿里代碼規(guī)范檢測(cè)中方法缺少javadoc注釋的問(wèn)題的文章就介紹到這了,更多相關(guān)阿里代碼規(guī)范缺少javadoc注釋內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: