阿里代碼規(guī)范檢測中方法缺少javadoc注釋怎么辦

發(fā)布時間：2020-08-12 15:01:48 來源：億速云閱讀：1902 作者：小新欄目：開發(fā)技術(shù)

這篇文章給大家分享的是有關(guān)阿里代碼規(guī)范檢測中方法缺少javadoc注釋怎么辦的內(nèi)容。小編覺得挺實(shí)用的，因此分享給大家做個參考。一起跟隨小編過來看看吧。

一、問題描述

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

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

提示信息為：

方法【findAll】缺少javadoc注釋

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

所有的抽象方法（包括接口中的方法）必須要用javadoc注釋、除了返回值、參數(shù)、異常說明外，還必須指出該方法做什么事情，實(shí)現(xiàn)什么功能。 說明：如有實(shí)現(xiàn)和調(diào)用注意事項(xiàng)，請一并說明。
  /**
   * 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);

二、問題分析

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

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

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

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

這里以IDEA為例

三、解決問題

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

點(diǎn)擊右邊的 + 號，選擇Template Group...來新建一個模板組

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

阿里代碼規(guī)范檢測中方法缺少javadoc注釋怎么辦

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

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

點(diǎn)擊Edit variables，一定要記得把勾都選上，return的值可以在下拉菜單找到，而Params的值請復(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) &#63; '\\n' : '')}; 
      return result ", methodParameters())

阿里代碼規(guī)范檢測中方法缺少javadoc注釋怎么辦

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

四、使用方法

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

阿里代碼規(guī)范檢測中方法缺少javadoc注釋怎么辦

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

感謝各位的閱讀！關(guān)于阿里代碼規(guī)范檢測中方法缺少javadoc注釋怎么辦就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，讓大家可以學(xué)到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！

向AI問一下細(xì)節(jié)

阿里代碼規(guī)范檢測中方法缺少javadoc注釋怎么辦

猜你喜歡

最新資訊

相關(guān)推薦

相關(guān)標(biāo)簽