如何在idea配置eclipse般的注释

起因,项目开发中方法名上的注释需要统一规范包括,方法描述、参数、返回值、创建时间等,无奈在idea中给方法上添加注释,idea可能由于功能太多,暂不支持扩展。本文通过设置Live Templates解决设置方法注释问题。

1.创建Template Group,在自己的自定义组里创建模板信息,如下图说明创建即可。

如何在idea配置eclipse般的注释_第1张图片

2.创建完成后,回到本章重点,配置方法注释模板信息,Live Templates ==》 Template text:  设置模板内容。具体内容如下:

**
 * @Description    :方法描述信息 
 * @Method_Name    :$methodName$ 
 *$param$ 
 * @return $return$  
 * @Creation Date  :$date$        
 * @Author         :作者邮箱信息
 */

3.设置完模板内容后才能编辑变量参数,因为先有模板中的变量才能进行变量的编辑,Edit variables:参数配置,以上模板各个变量设置的值如下:

methodName      methodName()
param                  groovyScript("_1.collect {' @param ' + it}.join('\\n* ') + ''", methodParameters())

                            groovyScript("_1.collect{' @param '+ it}.join('\\n'+' *') + ''",methodParameters())   更新版本,使*号对齐
return                  methodReturnType()

date                     date()

效果图如下:

如何在idea配置eclipse般的注释_第2张图片

4.编辑变量时可能会遇到变量保存不上的问题,那就试试设置完一个值后立马点ok看下;最后一排的Skip if defined建议所有变量都选上,作用是方法注释出来之后不会有光标聚焦某个变量上,取消后可能会出现一些样式上的问题,大家感兴趣可以自行配置试下。

5.总结:大家通过这次手动配置,应该了解了方法注释实现的原理和过程,先通过快捷键呼出模板内容=》模板内容通过配置变量表达式=》动态替换成自己想要的方法名、入参、时间等,而且idea中本身支持很多表达式,以上的例子中最难的表达式是param对应需要写一些动态的逻辑在里面,其他都是现成的;了解具体过程,以后这样大家配置出符合自己口味的任何注释了。

最后,希望大家确认过是对的标题,这就是你们想要的文章。

 

文末感谢老铁的文章加以参考,否则就没有相应的灵感了,双击666。

https://blog.csdn.net/chao_1990/article/details/79896979

你可能感兴趣的:(工具的使用)