idea中怎么设置类注释,和方法注释

原博主链接:https://blog.csdn.net/xiaoliulang0324/java/article/details/79030752

这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置:

类注释模板: idea中怎么设置类注释,和方法注释_第1张图片 方法注释模板:idea中怎么设置类注释,和方法注释_第2张图片

一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)

1、File–>settings–>Editor–>File and Code Templates–>Files

我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)

(1) N A M E : 设 置 类 名 , 与 下 面 的 {NAME}:设置类名,与下面的 NAME{NAME}一样才能获取到创建的类名

(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述

(3) U S E R 、 {USER}、 USER{DATE}、 T I M E : 设 置 创 建 类 的 用 户 、 创 建 的 日 期 和 时 间 , 这 些 事 I D E A 内 置 的 方 法 , 还 有 一 些 其 他 的 方 法 在 绿 色 框 标 注 的 位 置 , 比 如 你 想 添 加 项 目 名 则 可 以 使 用 {TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用 TIMEIDEA绿使{PROJECT_NAME}

(4)1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了
idea中怎么设置类注释,和方法注释_第3张图片

2、效果图展示
idea中怎么设置类注释,和方法注释_第4张图片

二、设置方法注释模板

IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是

/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释

1、File–>Settings–>Editor–>Live Templates
idea中怎么设置类注释,和方法注释_第5张图片

(1)新建组:命名为userDefine

idea中怎么设置类注释,和方法注释_第6张图片

(2)新建模板:命名为*

因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为

/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、

获取方法返回值的methodReturnType()
idea中怎么设置类注释,和方法注释_第7张图片

(3)设置生成注释的快捷键
idea中怎么设置类注释,和方法注释_第8张图片

(4)设置模板:模板内容如下

注意第一行,只有一个而不是/

在设置参数名时必须用 参 数 名 {参数名} 的方式,否则第五步中读取不到你设置的参数名

  • @Author chengpunan
  • @Description //TODO e n d end end
  • @Date t i m e time time d a t e date date
  • @Param p a r a m param param
  • @return r e t u r n return return
    **/
    如果使用/生成的模板注释将会是如下效果:所以我们要去掉最前面的/

(5)设置模板的应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可

(如果曾经修改过,则显示为change而不是define)

在这里插入图片描述
idea中怎么设置类注释,和方法注释_第9张图片

(6)设置参数的获取方式

选择右侧的Edit variables按钮

PS:第五步和第六步顺序不可颠倒,否则第六步将获取不到方法
idea中怎么设置类注释,和方法注释_第10张图片

选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多教程说获取param时使用脚本的方式,我试过使用脚本

的方式不仅麻烦而且只能在方法内部使用注释时才能获取到参数

idea中怎么设置类注释,和方法注释_第11张图片

(7)效果图

创建方法,在方法上面写:/*+模板名+Enter–>/**+Enter

idea中怎么设置类注释,和方法注释_第12张图片

你可能感兴趣的:(备忘)