Intellij IDEA设置类注释和方法注释

阅读目录

• 类注释
• 通过Live Templates方式生成

背景：工欲善其事必先利其器，如果不能把工具用熟练了， 感觉很是别扭。

参考：
IntelliJ IDEA设置类注释和方法注释

IntelliJ IDEA 中创建类的时候，可以直接自动给类加注释的设置，以及对方法的自动生成Java doc 注释的示范。

注释一共分为三种：

新建文件注释，已有类文件注释，方法注释

回到顶部

类注释

创建类时自动生成注释

File》settings》editor》File and Code Templates

修改File Header.java中的内容，新建interface class enum时候就会自动带有注释。

ps：这里使用在class interface enum地方都配置下述注释，这样可以在新建的时候输入注释。快捷方便。

这里没有使用@author这样的javadoc标签，是因为在idea中这些标签不会显示出来，不够友好，为了提高阅读性，使用下述的标签。

/**
 * <b>Description</b>:${Description}<br>
 *
 * <b>Author</b>:lixuwu<br>
 * <b>Date</b>:${YEAR}/${MONTH}/${DAY} ${TIME}<br>
 */

回到顶部

通过Live Templates方式生成

Fille》Editor》Live Templates，为了方便管理，新建一个分组来管理自己添加的Live Template

这里主要是用来在类或者方法已经存在的时候添加注释

类模板

在新建的组下面，新建Live Templates

快捷键：/*c+Tab  

模板内容：

**
 * <b>Description</b>: <br>
 * 
 * <b>Author</b>:lixuwu<br>
 * <b>Date</b>:$date$ $time$<br>
 */

 

 

ps：只能是上面的内容，不然的话，注释很多bug。

关联变量表达式

关联文件

方法模板

快捷键：/**+Tab

模板内容：

*
 * @description
 * @author lixuwu
 * @date $date$ $param$
 * @return $return$
 **/

 

关联变量：param直接复制下面的内容，然后回车即可

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

配置完后关联java文件。

在方法上面输入/**，然后按tab键便自动生成注释。

 ps：这里只是记录下配置方法，但是建议用ALT+ENTER来生成javadoc注释，这样比较方便。

字段注释

建议用ALT+ENTER

 

---

如果您觉得阅读本文对您有帮助，请点一下“推荐”按钮，让更多的人能够享受到获取知识的快乐！因为本人初入职场，鉴于自身阅历有限，所以本博客内容大部分来源于网络中已有知识的汇总，欢迎各位转载，评论，大家一起学习进步！如有侵权，请及时和我联系，切实维护您的权益！