如何在Idea 中添加注释：类注释和方法注释（可获取参数和返回值）

提示：记录学习生活，热爱永不止步，阅读本文大约需要10分钟

---

前言

提示：这里是文章的大概内容：

• 随着我们对代码质量要求的提高，很多的公司现在都要求给代码加上规范的注释，下面我将介绍一下如何在idea里面给类和方法自动加上注释。

---

提示：以下是本篇文章正文内容，下面案例可供参考

一、设置完成的样式

类的：

方法的：

二、如何设置？

1.设置类的注释

1. File->settings打开设置(快捷键ctrl+alt+s）
   
   

2. 打开editor
   

3. 打开这个
   

4. 修改这几个文件
   

5. 加入下面的代码
   

/**
 *@ClassName ${NAME}
 *@Description  TODO
 *@Author @O_o
 *@Date ${DATE} ${TIME}
 *@Version 1.0
 */

2.设置方法的注释

2. 这两步与上面的相同；
3. 选择LiveTemplates，我们先选择2创建一个模板组【参照我的】，再选择1创建一个模板；
   
4. 选择1创建一个模板，如下图
   

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

5. 编辑模板引用变量edit variables，如下图：
   
   param:

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())

总结

• 今天给大家详细介绍了如何在idea里面给类和方法自动加上注释，如果对您有帮助的话请点赞收藏❤，谢谢