IDEA 社区版的类注释和方法注释

---

一、IDEA中在创建类时会自动给添加注释

设置方法：

• File–>settings–>Editor–>File and Code Templates–>Files

（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}：设置创建类的用户、创建的日期和时间，这些是DEA内置的方法，还有一些其他的方法在红色框标注的位置；
② 比如你想添加项目名则可以使用TIME：设置创建类的用户、创建的日期和时间，这些是IDEA内置的方法，还有一些其他的方法在红色框标注的位置；
③ 比如你想添加项目名则可以使用{PROJECT_NAME}

二、方法上面输入/*然后回车，就有方法的注释

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

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

设置方法：

• File–>Settings–>Editor–>Live Templates

2.1 新建组

2.2 选中userDefine在其目录下新建模板：命名为*

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

/*add+Tab），如果不采用这样的生成方式IDEA中没有内容的方法将不可用；

例如获取方法参数的methodParameters(）、获取方法返回值methodReturnType(）

2.3 设置生成注释的快捷键

2.4 设置模板：模板内容如下

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

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

*
 * @Author Daniel
 * @Description //TODO 
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

2.5 设置模板的应用场景

点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere–>Java即可（如果曾经修改过，则显示为change而不是define）

我这里是全选的！！！

右键选中可以更改，change context；

然后选择要修改的即可！

2.6 设置参数的获取方式

依次下拉选择即可。
注意第五步和第六步的顺序不可颠倒哦~
idea不会默认帮我们设置，所以需要手动设置