IDEA参考注释规范
文章目录
楔子
本来也不是什么长篇大论,楔子也直入主题了:
开发过程中需要规范注释,而很多小伙伴现在用的是IDEA,于是分享现在我的注释模板是怎么配置的
废话就不多说了,我们进入主题。
配置教程
1. 首先打开IDEA(我的是2018.3.1版,其余版本可能会有些出入)
2. 进入主界面后打开左上角File>Settings(也可以快捷键ctrl+alt+s)
3. 进入设置界面,找到Editor>Live Templates
4. 点击右侧+号,创建一个群组,命名为My Group
5. 然后我们会看到一个名为My Group的群组,选择该群组,再次点击+号,创建一个Live Template
6. 按照下图配置,名字为一个星号,Description为method
Template text里的内容为(注意空格和缩进)
*
* @Description TODO
* @author LaoQin
* @date $date$
$params$
* @return $return$
*/
7. 然后点击Edit variables,分别编辑3个变量的值如下
以下是上述Default value里的内容
Name | Default value |
---|---|
date | date() |
params | 内容过长,单独放在下面了 |
return | methodReturnType() |
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()) 1
8. 点击ok再回到之前的页面点击ok
结束
接下来我们就可以输入/**然后敲enter(或者tab)键看最终的效果了
@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class ApiEsApplication {
/**
* @Description TODO
* @author LaoQin
* @date 2020/01/09
* @param args
* @return void
*/
public static void main(String[] args) {
SpringApplication.run(ApiEsApplication.class, args);
}
}
–完--