這篇文章主要介紹了IDEA 自定義方法註解模板的實現方法,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨着小編來一起學習學習吧
1、使用效果
/** * 計算交易費用 * @Author wangjiafang * @Date 2019/9/11 * @param feeComputeVo * @return */ @PostMapping("/v1/fee_compute") public ApiResponse feeCompute(@RequestBody @Valid FeeComputeVo feeComputeVo){ return new ApiResponse(); }
2、設置步驟-添加自定義方法
File->settings->Editor->Live Templates
擊右上角的綠色+號,然後選擇template group ,然後輸入group的name,隨便輸入就好了:wangjiafang。然後點ok
選中剛纔創建的wangjiafang,然後再次點擊右側的綠色+,這次選擇的是第一個 Live Template
取名爲*
Live Template 定義的模板名是 * , 按/**, 然後space鍵盤, 方法註釋就生產了,非常完美!; 網上普遍的方式是將模板名定義爲: mc, 使用方式也相應不同, 其實使用方式倒無所謂, 但是mc這種方式有個要求, 必須再方法內使用才行,要不產生的註釋param 是null..., 所以你用這種方式,要麼你忍受方法內寫註釋,要麼你手動把方法內生成的註釋移到外面
把Expand with中 默認enter 修改爲space,當然你也可以修改爲其他的快捷方式;爲什麼要什麼默認的enter,因爲 /** 是idea的默認註釋快捷,和要使用默認註釋模板的地方衝突
註釋模板代碼
/* * $desc$ * @Author wangjiafang * @Date $date$ $params$ * @return */
3、設置步驟-添加方法中的變量
IDEA 中methodParameters(), 是數組的形式([aParam, bParam, cParam]這樣的結構),需要對methodParameters() 函數進行處理,處理腳本如下:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + '\\t' + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持神馬文庫。