IDEA中规范java代码注释

在IDEA中规范java代码注释的使用,类文件增加类注释,方法增加方法注释。

一、创建文件时创建类注释

image.png
/**
* @author ${USER}
* @date ${DATE} ${TIME}
*/

二、文件创建后类注释和方法注释

  1. 创建live Templates Group ,明明为UserDefined


    image.png
  2. 创建类注释,输入/* 然后enter回车后执行


    image.png

    (1)点击1处添加live temp,abbreviation 填入 *
    (2)template text 填入

**
* $description$
* @author $user$
* @date $date$ $time$
*/

(3)change处选择java
(4)edit variables


image.png
  1. 创建方法注释,输入/**然后enter回车后执行
    方法同上
    (1)点击1处添加live temp,abbreviation 填入 **
    (2)template text 填入
**
* $description$
$params$
* @return $returns$
* @author $user$
* @date $date$ $time$
*/

(3)change处选择java
(4)edit variables


image.png

params的值为

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())
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容