欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2023-12-17 18:42:52
近日在研究重构代码的时候有用到idea的不少插件,比如checkstyle,同时下载了阿里的开发规约,受到不少启发。 规约中会要求所有的方法都有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)来打开生成窗口:

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

这里我们选择getter and setter。

打开如下窗口:

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

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

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

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

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

点击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;
}

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

 完毕后点击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;
}

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

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

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

点击ok。

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

到这里算是大功告成了。

总结

以上所述是小编给大家介绍的idea设置生成带注释的getter和setter的图文教程,希望对大家有所帮助

上一篇:

下一篇: