目錄
自定義的類注釋
自定義方法注釋
????????實現效果:不用手寫即可自動生成如下圖的類上注釋和方法上的注釋,我們只需要填寫方法注釋的參數和返回值文字描述即可,大大節省了代碼開發的時間提高代碼開發效率。
🌕 自定義的類注釋
File-->Settings-->Editor-->File?and Code Templates
注解內容可自定義,我給出的模板只是我自己的內容
/**@ClassName: @Description: @author: chenhao@date: ${DATE}
*/
🌕 自定義方法注釋
File-->Settings-->Editor-->LiveTemplates
第一步:新建一個分組,名稱自定義
第二步:編輯模板
** *$params$ * @author: chenhao* @return: */
第三步:編輯變量?
groovyScript(" def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { if(i == 0 && params[0] == '') result=''; else if(i == 0) result += ' \\n' + ' * @param ' + params[i] + ' ' + ((i < params.size() - 1) ? '\\n' : ''); else result += ' * @param ' + params[i] + ' ' + ((i < params.size() - 1) ? '\\n' : '') }; return result", methodParameters() )
?第四步:編輯快捷鍵最后一步
效果展示
🌕 優化設置?
????????通過上述步驟可以實現自定義的類上和方法上注釋,但是有一點美中不足的是:設置之后idea會報黃色的warning,雖然不影響運行吧,但是對于有些削微強迫癥的我來說,這還是不太能忍受的,那么就想辦法祛除這種warning吧
?Settings? => Editor => Inspections =>?復制并搜索Declaration has Javadoc Problems. => options => add java doc tags
?修改配置后的代碼就沒有了報黃,看起來就很是賞心悅目