溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
這篇文章給大家分享的是有關阿里代碼規范檢測中方法缺少javadoc注釋怎么辦的內容。小編覺得挺實用的，因此分享給大家做個參考。一起跟隨小編過來看看吧。
一、問題描述
安裝了阿里代碼檢測的插件后，敲一個簡單的方法，發現提示有問題，如下
/** * 查找User的集合 */ List<User> findAll();
提示信息為：
方法【findAll】缺少javadoc注釋
進一步查看完整文檔里面關于方法注釋的規范為
所有的抽象方法（包括接口中的方法）必須要用javadoc注釋、除了返回值、參數、異常說明外，還必須指出該方法做什么事情，實現什么功能。 說明：如有實現和調用注意事項，請一并說明。 /** * 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);
二、問題分析
從阿里提供的代碼規范我們可以知道以下信息：
1.要包含方法說明
2.要包含參數列表
3.要包含返回值類型
4.要嚴格注意注釋的縮進和星號數量
而關于日期、作者、時間這些并沒有做要求
所以我們可以通過添加模板的方法，來實現自動注釋，避免警告
這里以IDEA為例
三、解決問題
點擊 File - Settings... - Editor - Live Templates
點擊右邊的 + 號，選擇Template Group...來新建一個模板組
輸入模板組的名稱，這里以myJava為例，然后在模板組下點擊+號Live Template
注釋文本如下，可以直接復制，除了必要的參數列表和返回值后，你還可以自定義方法名、作者、日期等等，這里不再贅述
/** * description: * @Param $PARAMS$ $RETURN$ */
點擊Edit variables，一定要記得把勾都選上，return的值可以在下拉菜單找到，而Params的值請復制以下表達式
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())
點擊Apply或者ok，就大功告成了！
四、使用方法
編寫完方法后在方法上面輸入/*，再按TAB鍵就會自動生成模板，然后在第一行輸入方法描述就符合規范啦！
注意事項：官方文檔中要求@參數需要小寫，如果寫成了@Return就是錯誤的，應該寫成@return
感謝各位的閱讀！關于阿里代碼規范檢測中方法缺少javadoc注釋怎么辦就分享到這里了，希望以上內容可以對大家有一定的幫助，讓大家可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
