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

参考:
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

Intellij IDEA设置类注释和方法注释的更多相关文章

  1. intellj idea 如何设置类头注释和方法注释

    intellj idea 如何设置类头注释和方法注释           intellj idea的强大之处就不多说了,相信每个用过它的人都会体会到,但是我们也会被他的复杂搞的晕头转向,尤其刚从ecl ...

  2. IntelliJ Idea注释模板--类注释、方法注释

    刚从Eclipse切换到IntelliJ Idea,之前使用eclipse时用到了注释模板,包括类注释和方法注释,现在分别讲一下在Intellij Idea中如何进行配置,作为备忘 一. 类注释模板配 ...

  3. idea如何设置类头注释和方法注释

    CSDN 2016博客之星评选结果公布      [系列直播]算法与游戏实战技术      "我的2016"主题征文活动 详细:idea如何设置类头注释和方法注释 标签: idea ...

  4. idea 类注释,方法注释设置

    类头注释:打开file->setting->Editor->Filr and Code Templates->Includes->File Header 直接在右边的文件 ...

  5. 【IDEA】设置类头注释和方法注释

    idea和eclipse的注释还是有一些差别的. 类头注释: 打开file->setting->Editor->Filr and Code Templates->Include ...

  6. Idea 添加注释:类注释、方法注释(可获取参数)

    原文链接:https://blog.csdn.net/liqing0013/article/details/84104419 Idea 添加注释:类注释.方法注释 类注释 File–Setting–E ...

  7. 【IDEA】头注释和方法注释

    头注释和方法注释 2020-09-08  10:16:17  by冲冲 1.头注释 ①设置 ②模板内容 /** * @ClassName ${NAME} * @Description ${DESCRI ...

  8. IntelliJ IDEA 如何设置类头注释和方法注释

    从VS转过来的,ide的差距很大的,所以...特意折腾了很久,结果还是没有VS的 '///' 好用 一.类头注释 打开file -> setting -> Editor -> Fil ...

  9. 详细:idea如何设置类头注释和方法注释

    IntelliJ IDEA 类注释和自定义方法注释   来源:https://my.oschina.net/baishi/blog/617478#navbar-header intellj idea的 ...

随机推荐

  1. Exception的异常分类与处理

    一. 异常:  1:错误的分类          1)Error:错误(不可控),一般指的是系统方面的异常,比如 蓝屏,内存溢出,jvm运行环境出现了问题.          2) Exception ...

  2. tasklist /m

    \>tasklist /m explorer*映像名称                       PID 模块                                        = ...

  3. cc2530单片机的第一次实验,流水灯

    第一个实验:控制流水灯 P1_0,P1_1,P0_4都连接在发光二极管的负极,所以,当这三个引脚为低电平,也就是0的时候,相应的发光二极管才会亮. 其实这里可以稍微的关注一下寄存器的地址,然后,编程的 ...

  4. 面试题必备-web页面基础

    html标签是由<>包围的关键词 html标签是成对出现的 有部分标签是没有结束标签的,叫单标签, 页面中所有的内容,都是要放在HTML标签中的 HTML标签分三部分: 标签名称 标签内容 ...

  5. Linux expect详解

    随处可见的expect第一次见expect这个命令还是我第一次参加全量上线的时候,那是公司的一个牛人用Shell脚本写的一套自动部署.MD5 比对.发布的全量上线工具,没事的时候,看了下其中的几个脚本 ...

  6. java复制对象之深拷背

    在java开发中,有时我们需要复制对象,并且确保修改复制得到的对象不会影响原来的对象. 于是,有些人可能会写出类似以下的代码: public class CloneTest { public stat ...

  7. linux安装yasm报错

    进入yasm-1.2.0, 输入指令 ./configure //编译yasm make && make install //安装yasm,安装完成即可. 报错信息 make[2]: ...

  8. Tensorflow 损失函数(loss function)及自定义损失函数(三)

    版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明. 本文链接:https://blog.csdn.net/limiyudianzi/article ...

  9. UDP丢包原因总结

    丢包检查方法 给每个UDP包编号,对比收发端的接收到的包.对于UDP协议层上的包,例如RTP包,可以从RTP包中读出包的序列号进行判断. 抓包.发送端和接收端分别抓包.linux下可以使用tcpdum ...

  10. pg数据库中时间查询的方式

    方法一:select * from user_info where create_date>= '2015-07-01' and create_date < '2015-08-15'; 方 ...