IntelliJ IDEA为类和方法自动添加注释

转自 IntelliJ IDEA为类和方法自动添加注释 - 淼淼之森 - 博客园 (cnblogs.com)

<div id="cnblogs_post_body" class="blogpost-body blogpost-body-html"><a rel="nofollow noopener" name="_labelTop"></a><div id="navCategory"><p style="font-size:18px"><b>阅读目录：</b></p><ul><li><a rel="nofollow noopener" href="#_label0">1、为类添加自动注释模版</a></li><li><a rel="nofollow noopener" href="#_label1">2、为方法添加自动注释模版</a></li></ul></div><p> </p><p style="font-size:18px"><b>阅读正文：</b></p>
<div style="text-align: right"><a rel="nofollow noopener" href="#_labelTop">回到顶部</a><a rel="nofollow noopener" name="_label0"></a></div><h2>1、为类添加自动注释模版<button class="cnblogs-toc-button" title="显示目录导航" aria-expanded="false"></button></h2>
<p>File-->Settings-->Editor-->File and Code Templates</p>
<p><img src="https://images2018.cnblogs.com/blog/1196304/201804/1196304-20180416210656007-865157173.png" alt="" width="784" height="475" class="medium-zoom-image"></p>
<div class="cnblogs_code"><div class="cnblogs_code_toolbar"><span class="cnblogs_code_copy"><a href="javascript:void(0);" onclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></span></div>
<pre><span style="color: rgba(0, 128, 0, 1)">/**</span><span style="color: rgba(0, 128, 0, 1)">
* @author ：mmzs
* @date ：Created in ${DATE}$ {TIME}
* @description： ${description} * @modified By： * @version:$ version$
</span><span style="color: rgba(0, 128, 0, 1)">*/</span></pre>
<div class="cnblogs_code_toolbar"><span class="cnblogs_code_copy"><a href="javascript:void(0);" onclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></span></div></div>
<p>此时，当你创建新的类时，就会自动生成注释了。</p>
<p><strong><span style="color: rgba(255, 0, 0, 1)">注意：</span></strong>一定要启用该模板才有效</p>
<p><img src="https://img2018.cnblogs.com/blog/1196304/201812/1196304-20181226170600143-1951948108.png" alt="" class="medium-zoom-image"></p>
<p>如果还不行，就添加如下设置：</p>
<p><img src="https://img2018.cnblogs.com/blog/1196304/201812/1196304-20181226172224418-580591192.png" alt="" class="medium-zoom-image"></p>
<p> </p>
<p> </p>
<div style="text-align: right"><a rel="nofollow noopener" href="#_labelTop">回到顶部</a><a rel="nofollow noopener" name="_label1"></a></div><h2>2、为方法添加自动注释模版<button class="cnblogs-toc-button" title="显示目录导航" aria-expanded="false"></button></h2>
<p>File-->Settings-->Editor-->Live Templates</p>
<p><img src="https://images2018.cnblogs.com/blog/1196304/201804/1196304-20180416211106996-2026745365.png" alt="" width="727" height="443" class="medium-zoom-image"></p>
<p>点击"+"号后，选择"Templates Group…"</p>
<p><img src="https://images2018.cnblogs.com/blog/1196304/201804/1196304-20180416211307279-834557272.png" alt="" width="721" height="437" class="medium-zoom-image"></p>
<p><img src="https://images2018.cnblogs.com/blog/1196304/201804/1196304-20180416211529411-1997515790.png" alt="" width="721" height="442" class="medium-zoom-image"></p>
<p><img src="https://images2018.cnblogs.com/blog/1196304/201804/1196304-20180416211648871-569819658.png" alt="" width="722" height="439" class="medium-zoom-image"></p>
<p><span style="color: rgba(255, 0, 0, 1)"><strong>注意：</strong></span>此处一定要为刚刚的模板指定使用范围：</p>
<p><img src="https://img2018.cnblogs.com/blog/1196304/201812/1196304-20181226170118699-1763661030.png" alt="" class="medium-zoom-image"></p>
<p><strong><span style="color: rgba(255, 0, 0, 1)">例如：</span></strong>我指定的是java</p>
<p><img src="https://img2018.cnblogs.com/blog/1196304/201812/1196304-20181226170213130-776808209.png" alt=""></p>
<p>注释模板填写内容参考如下：</p>

<div class="cnblogs_code"><div class="cnblogs_code_toolbar"><span class="cnblogs_code_copy"><a href="javascript:void(0);" onclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></span></div>
<pre><span style="color: rgba(0, 128, 0, 1)">/**</span><span style="color: rgba(0, 128, 0, 1)">
* create by: mmzs
* description: TODO
* create time: $date$ $time$
*
$params$
* </span><span style="color: rgba(128, 128, 128, 1)">@return</span><span style="color: rgba(0, 128, 0, 1)"> $return$
</span><span style="color: rgba(0, 128, 0, 1)">*/</span></pre>
<div class="cnblogs_code_toolbar"><span class="cnblogs_code_copy"><a href="javascript:void(0);" onclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></span></div></div>
<p><img src="https://images2018.cnblogs.com/blog/1196304/201804/1196304-20180416211742484-242269389.png" alt="" width="725" height="265" class="medium-zoom-image"></p>
<p>params的Exception内容如下：</p>
<div class="cnblogs_code">
<pre>groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @'+'Param: ' + params[i] + ((i < params.size() - 1) ? '\\n'+'\\b' : '')}; return result", methodParameters())</pre>
</div>
<p> 点击Ok。</p>
<p>此时，在方法体内部输入add+Tab就可以生成注释了。</p>
<div id="signature"><br><br><hr><p id="signature-p">作者：<a rel="nofollow noopener" href="http://www.cnblogs.com/mmzs/">淼淼之森</a><br>欢迎任何形式的转载，但请务必注明出处。<br>如果你觉得本文还可以，那就点击一下推荐，让更多人看到吧！<br>限于本人水平，如果文章和代码有表述不当之处，还请不吝赐教。</p></div></div>