IDEA注释模板

参考资料

Share live templates | IntelliJ IDEA Documentation (jetbrains.com)

优势

优势主要体现在方法模板：

1. 格式不容易乱
2. 没有参数时不会出现@param
3. 没有返回值时不会出现@return
4. 使用了IDEA预定义的END变量，自动结束填充
5. 固定日期格式为"yyyy-MM-dd"，不会随平台变化

导入步骤

一、使用快捷键Ctrl+Alt+S打开设置（或其他方式）

二、依次选择【编辑器】【实时模版】(【Editor】【Live Templates】)

三、选择右侧中的加号，创建一个名为AA的模版组，如下图所示

四、将下面提供的模板中的作者名修改为你的名字，然后全部复制，选择刚创建的模板组，使用Ctrl+S粘贴，最后点击【确定】即可

模板如下（待修改）：

<template name="cc" value="/**&#10; * $END$&#10; * &#10; * @author $author$&#10; * @date $date$&#10; */" shortcut="ENTER" description="class, trigger by &quot;cc&quot;" toReformat="false" toShortenFQNames="true">
  <variable name="author" expression="enum(&quot;TODO&quot;)" defaultValue="" alwaysStopAt="false" />
  <variable name="date" expression="date(&quot;yyyy-MM-dd&quot;)" defaultValue="" alwaysStopAt="false" />
  <context>
    <option name="JAVA" value="true" />
    <option name="JAVA_CODE" value="true" />
  </context>
</template>
<template name="ff" value="/** $END$ */" shortcut="ENTER" description="field, trigger by &quot;ff&quot;" toReformat="false" toShortenFQNames="true">
  <context>
    <option name="JAVA" value="true" />
    <option name="JAVA_CODE" value="true" />
  </context>
</template>
<template name="mm" value="**&#10; * $END$&#10; *&#10;$param$$return$ * @author $author$&#10; * @date $date$&#10; */" shortcut="ENTER" description="method, trigger by &quot;/mm&quot;" toReformat="false" toShortenFQNames="true">
  <variable name="param" expression="groovyScript(&quot;def result=''; def params=\&quot;${_1}\&quot;.replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); if(params.size()==1 &amp;&amp; params[0]=='') return ''; for(i = 0; i &lt; params.size(); i++) {result+=' * @param ' + params[i] + ' TODO\\n'}; return result&quot;, methodParameters())" defaultValue="" alwaysStopAt="false" />
  <variable name="return" expression="groovyScript(&quot;return _1=='void' ? '' : ' * @return TODO\\n'&quot;, methodReturnType())" defaultValue="" alwaysStopAt="false" />
  <variable name="author" expression="enum(&quot;TODO&quot;)" defaultValue="" alwaysStopAt="false" />
  <variable name="date" expression="date(&quot;yyyy-MM-dd&quot;)" defaultValue="" alwaysStopAt="false" />
  <context>
    <option name="JAVA" value="true" />
    <option name="JAVA_CODE" value="true" />
  </context>
</template>

修改示意：

使用示例

方法注释

输入/mm,并回车

类注释

输入cc,并回车

成员变量注释

输入ff,并回车