解決阿里代碼規(guī)范檢測中方法缺少javadoc注釋的問題
一、問題描述
安裝了阿里代碼檢測的插件后,敲一個簡單的方法,發(fā)現(xiàn)提示有問題,如下
/** * 查找User的集合 */ List<User> findAll();
提示信息為:
方法【findAll】缺少javadoc注釋
進一步查看完整文檔里面關于方法注釋的規(guī)范為
所有的抽象方法(包括接口中的方法)必須要用javadoc注釋、除了返回值、參數(shù)、異常說明外,還必須指出該方法做什么事情,實現(xiàn)什么功能。 說明:如有實現(xiàn)和調用注意事項,請一并說明。 /** * 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.要嚴格注意注釋的縮進和星號數(shù)量
而關于日期、作者、時間這些并沒有做要求
所以我們可以通過添加模板的方法,來實現(xiàn)自動注釋,避免警告
這里以IDEA為例
三、解決問題
點擊 File
- Settings...
- Editor
- Live Templates
點擊右邊的 +
號,選擇Template Group...
來新建一個模板組
輸入模板組的名稱,這里以myJava為例,然后在模板組下點擊+
號Live Template
注釋文本如下,可以直接復制,除了必要的參數(shù)列表和返回值后,你還可以自定義方法名、作者、日期等等,這里不再贅述
/** * 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
鍵就會自動生成模板,然后在第一行輸入方法描述就符合規(guī)范啦!
注意事項:官方文檔中要求@參數(shù)
需要小寫,如果寫成了@Return
就是錯誤的,應該寫成@return
到此這篇關于解決阿里代碼規(guī)范檢測中方法缺少javadoc注釋的問題的文章就介紹到這了,更多相關阿里代碼規(guī)范缺少javadoc注釋內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
Java將集合List轉換成String字符串(或String轉換成List)詳解
今天在寫項目的時候遇到一個問題,就是要把得到的一個集合轉換成字符串,下面這篇文章主要給大家介紹了關于Java將集合List轉換成String字符串(或String轉換成List)的相關資料,需要的朋友可以參考下2023-06-06Java異常處理操作 Throwable、Exception、Error
這篇文章主要介紹了Java異常處理操作 Throwable、Exception、Error,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-06-06一小時迅速入門Mybatis之Prepared Statement與符號的使用
這篇文章主要介紹了一小時迅速入門Mybatis之Prepared Statement與符號的使用,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-09-09