IDEA设置生成带注释的getter和setter的图文教程

 更新时间:2018年05月17日 12:05:02   作者:陈先生丶  
通常我们用idea默认生成的getter和setter方法是不带注释的,当然,我们同样可以设置idea像MyEclipse一样生成带有Javadoc的模板,具体设置方法,大家参考下本文

近日在研究重构代码的时候有用到idea的不少插件,比如CheckStyle,同时下载了阿里的开发规约,受到不少启发。

规约中会要求所有的方法都有Javadoc,但是通常我们用idea默认生成的getter和setter方法是不带注释的,当然,我们同样可以设置idea像MyEclipse一样生成带有Javadoc的模板,具体解决方案如下:

 比如我们有这么一个pojo类:

/**
 * 人类.
 * @author eric
 */
public final class People {

 /**
  * 姓名.
  */
 private String name;
 /**
  * 年龄.
  */
 private Integer age;

}

这个时候我们按下 Alt + Insert (Windows),或者 Command + N (MacOS)来打开生成窗口:

这里我们选择Getter and Setter。

打开如下窗口:

我们点击如图箭头所示的地方,打开如下视图:

然后我们新建一个Template,点击图中的 "+" 号,然后输入名称(当然你可以起个自己喜欢的名称)

点击OK。之后在编辑区域复制粘贴如下代码:

/**
 * Gets the value of $field.name
 * @return the value of $field.name
 */
public ##
#if($field.modifierStatic)
 static ##
#end
$field.type ##
#set($name = $StringUtil.capitalizeWithJavaBeanConvention($StringUtil.sanitizeJavaIdentifier($helper.getPropertyName($field, $project))))
#if ($field.boolean && $field.primitive)
 #if ($StringUtil.startsWithIgnoreCase($name, 'is'))
  #set($name = $StringUtil.decapitalize($name))
 #else
  is##
 #end
#else
 get##
#end
${name}() {
 return $field.name;
}

 完毕后点击OK。

Setter的配置同上一致,我们只需将编辑区内的代码改下(当然Template Name也可以改下:D):

/**
 * Sets the $field.name
 * <p>You can use get$StringUtil.capitalizeWithJavaBeanConvention($StringUtil.sanitizeJavaIdentifier($helper.getPropertyName($field, $project)))() to get the value of $field.name</p>
 * @param $field.name $field.name
 */
#set($paramName = $helper.getParamName($field, $project))
public ##
#if($field.modifierStatic)
 static ##
#end
void set$StringUtil.capitalizeWithJavaBeanConvention($StringUtil.sanitizeJavaIdentifier($helper.getPropertyName($field, $project)))($field.type $paramName) {
#if ($field.name == $paramName)
 #if (!$field.modifierStatic)
  this.##
 #else
  $classname.##
 #end
#end
$field.name = $paramName;
}

下面就让我们来看下成果:

在这里注意要选择我们刚配置好的Template,而不是Default。

点击OK。

到这里算是大功告成了。

总结

以上所述是小编给大家介绍的IDEA设置生成带注释的getter和setter的图文教程,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!

相关文章

  • Java Apache Shiro安全框架快速开发详解流程

    Java Apache Shiro安全框架快速开发详解流程

    Apache Shiro是一个强大且易用的Java安全框架,执行身份验证、授权、密码和会话管理。使用Shiro的易于理解的API,您可以快速、轻松地获得任何应用程序,从最小的移动应用程序到最大的网络和企业应用程序
    2021-10-10
  • java中将list用逗号隔开拼成字符串的4种方法例子

    java中将list用逗号隔开拼成字符串的4种方法例子

    我们经常在开发过程之中会遇到需要把返回的Id list转换为一个使用逗号(,)分隔的字符串,下面这篇文章主要给大家介绍了关于java中将list用逗号隔开拼成字符串的4种方法例子,需要的朋友可以参考下
    2024-01-01
  • springboot+mybatis+枚举处理器的实现

    springboot+mybatis+枚举处理器的实现

    在Spring boot项目开发中经常遇到需要使用枚举的场景,本文就介绍了springboot+mybatis+枚举处理器的实现,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-03-03
  • Java之网络编程案例讲解

    Java之网络编程案例讲解

    这篇文章主要介绍了Java之网络编程案例讲解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-07-07
  • java利用StringTokenizer分割字符串的实现

    java利用StringTokenizer分割字符串的实现

    利用java.util.StringTokenizer的方法,可以将一个字符串拆分为一系列的标记,本文就来介绍一下java利用StringTokenizer分割字符串的实现,感兴趣的可以了解一下
    2023-10-10
  • 使用springboot的jar包能够以service方式启动

    使用springboot的jar包能够以service方式启动

    这篇文章主要介绍了使用springboot的jar包能够以service方式启动,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • Java实现读取键盘输入保存到txt文件,再统计并输出每个单词出现次数的方法

    Java实现读取键盘输入保存到txt文件,再统计并输出每个单词出现次数的方法

    这篇文章主要介绍了Java实现读取键盘输入保存到txt文件,再统计并输出每个单词出现次数的方法,涉及java文件I/O操作及字符串遍历、运算实现统计功能相关技巧,需要的朋友可以参考下
    2017-07-07
  • Spring框架初始化解析

    Spring框架初始化解析

    这篇文章主要介绍了Spring框架初始化解析,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • try-cache-finally读取文件错误try-with-resources使用方法

    try-cache-finally读取文件错误try-with-resources使用方法

    这篇文章主要为大家介绍了try-cache-finally读取文件错误try-with-resources使用方法详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02
  • Intellij IDEA下Spring Boot热切换配置

    Intellij IDEA下Spring Boot热切换配置

    这篇文章主要介绍了Intellij IDEA下Spring Boot热切换配置,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-08-08

最新评论