IDEA自定义带JavaDoc的getter/setter模板

最新推荐文章于 2024-04-22 17:50:29 发布

转载最新推荐文章于 2024-04-22 17:50:29 发布 · 555 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://my.oschina.net/yidao620c/blog/3069396

文章标签：

#开发工具 #java

本文介绍在IntelliJ IDEA中如何自定义生成Getter和Setter方法的模板，包括添加JavaDoc注释，使代码更加规范和易于理解。通过简单的步骤，可以为项目中的属性快速生成带有说明的访问方法。

IDEA里面按Alt+Insert可弹出生成getter/setter方法模板的提示，默认的模板并不会带JavaDoc。可自定义模板

getter模板

/**
 * 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)
  is##
#else
  get##
#end
${name}() {
  return $field.name;
}

setter模板

/**
 * 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;
}

转载于:https://my.oschina.net/yidao620c/blog/3069396