IntelliJ IDEA的类注释和方法注释

效果图如下：
类注释：

方法注释：

idea不会默认帮我们设置，所以需要手动设置。

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

模板：

/**
* @author ${USER}
* @Description 
* @date ${DATE} ${TIME}
**/

2.在方法的上面一行输入/*然后回车，就有方法的注释设置如下

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

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

1、File–>Settings–>Editor–>Live Templates

1）新建组：命名为userDefine

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

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

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

（3）设置生成注释的快捷键

（4）设置模板：模板内容如下
注意第一行，只有两个*而不是/

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

*
 * @author sxyuser
 * @description //TODO 
 * @date $date$ $time$ $param$ $return$ 
 */

需要注意首行没有 /，且 * 是顶格的。

（5）设置模板的应用场景

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

（6）设置参数的获取方式

依次下拉选择即可。

需要注意的是，date 和 time 的 Expression 使用的是 IDEA 内置的函数，直接使用下拉框选择就可以了，而 param 这个参数 IDEA 默认的实现很差，因此我们需要手动实现，代码如下：

groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())

另外 return这个参数我也自己实现了下，代码如下：

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

注：你还注意到我并没有勾选了 Skip if defined 属性，它的意思是如果在生成注释时候如果这一项被定义了，那么鼠标光标就会直接跳过它。我并不需要这个功能，因此有被勾选该属性。

注意第五步和第六步的顺序不可颠倒哦~

Q & A

（1）为什么模板的Abbreviation 一定要叫 * ？Expand with 要保证是 Enter 键？
答：因为 IDEA 模板的生成逻辑是 模板名 + 生成键，当生成键是 Enter 时，我们输入 * + Enter 就能够触发模板。
这也同时说明了为什么注释模板首行是一个 * 了，因为当我们先输入 /*，然后输入 * + Enter，触发模板，首行正好拼成了 /**，符合 Javadoc 的规范。
（2）注释模板中为什么有一行空的 * ？
答：因为我习惯在这一行写方法说明，所以就预留了一行空的写，你也可以把它删掉。
（3）注释模板中 $ time$ $ param$ 这两个明明不相干的东西为什么紧贴在一起？
答：首先网上提供的大部分 param 生成函数在无参情况下仍然会生成一行空的 @param ，因此我对param 函数的代码进行修改，使得在无参情况下不生成 @param ，但是这就要求 $param$ 要和别人处在同一行中，不然没法处理退格。
（4）为什么 return 参数不使用 methodReturnType() ，而要自己实现？
答： methodReturnType() 在无返回值的情况下会返回 void，这并没有什么意义，因此我对 methodReturnType() 返回值进行了处理，仅在有返回值时才生成。
（5）为什么 $return$ 不是单独一行？
答：因为当 methodReturnType() 返回 null 时，无法处理退格问题，原因同第三点。

原文地址