idea 设置代码样式-编程知识

idea 设置代码样式

news/2024/11/15 0:48:22/文章来源:https://www.cnblogs.com/Marydon20170307/p/18394120

设置类注释模板

　　类注释：File-->Settings-->Editor-->File and CodeTemplates

　　将如下代码拷贝到上图右侧空白区域即可（这个更为详细，具体用哪个自己决定）

/**** @description * @author ${USER}* @date ${DATE}* @version 1.0* @email marydon20170307@163.com*/

　　需要注意的是：class的注释，只有在新建文件的时候，会自动生成。

说明：

阿里巴巴规范指定：所有的类都必须添加创建者和创建日期，且类的日期的设置统一为 yyyy/MM/dd 的格式。

如果你的日期标签不是上述格式，我们可以通过下面进行指定。

或者使用这个

/*** * @description * @author ${USER}* @date ${YEAR}/${MONTH}/${DAY}* @version 1.0.0* @email marydon20170307@163.com*/

　　举个例子，复制原文件生成的新文件，是无法重新生成注释的，或者你把原来的注释删除，重新生成也是不行的，这一点相当恶心人（下面有解决办法）。

　　如上图所示，我的date显示格式为：2020年07月10日 0010 12:03，估计大家的日期格式也会五花八门，造成这样的原因，一般是修改了windows系统时间的显示格式。那该如何生成我们想要的日期格式呢？

　　配置这个就可以啦

/**** @description * @author ${USER}* @date ${YEAR}-${MONTH}-${DAY} ${TIME}* @version 1.0* @email marydon20170307@163.com*/

修改Class、Interface和Enum类的模板

说点题外话（可以不看）

　　之所以我们设置了File Header后，新建java文件能引用这个里的注释模板，是因为它引入了我们刚才修改的文件（不用我们管，idea已经配好了）

20200827

　　上面的类注释，只能在新建java类时有效，但在实际开发过程中，我们通常会直接复制类似的java类，来快速完成类的创建，而往往不是同一人开发的，所以会导致类的注释模板与自己之前的不统一的情况，所以，有必要创建一个可以通过调用快捷键来生成类注释模板。

　　新建组和模板的方法，方法注释有讲解，因为是后期添加的，所以，可以先看方法注释，然后再回来创建。

　　配置快捷键，这里，我定义为**

　　设置该模板的使用范围：java--》comment（注释，勾选其它的，在别的地方，其实也用不到，所以没有勾选的必要）

　　配置模板

**** @description * @author $USER$* @date $DATE$* @version 1.0* @email marydon20170307@163.com*/

　　配置变量对应的函数表达式　　

　　在需要添加类注释的地方，打上/**，按Tab键即可

　　注意：这里没有函数year()、month()和day()，用来表示日期的，只能是date()，所以，这里无法自定义年月日的表现形式，目前没有解决办法，只能手动修改展示格式。

方法注释

File-->Settings-->Editor-->Live Templates

　　点击右上角的+号，然后选择Template Group，然后输入group的name，我这里输入：Java，然后点ok

　　选中刚才创建的MyGroup，然后再次点击右侧的+，这次选择的是第一个Live Template。取名为 *（必须是这个）

　　将如下代码拷贝到上图左侧空白区域

旧版

*
* 
* @attention 
* @date $date$ $time$
$params$
* @return $return$
*/

　　注意：必须是*开头，而不是/**开头，另外这个*必须顶格。

2024版

*** * @attention * @date $date$ $time$$params$$return$*/

　　配置好模板后，点击右侧的 Editor variables配置变量

　　模板参数对应的值如下：

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

　　将其对应的模板值，依次拷贝到对应的Expression中，如下图所示