IDEA配置类注释和方法注释
首先展示效果图,每当创建一个类时,会自动的添加注解,作者的从事行业的时间(需自己添加),以及在哪个项目下创建的类名信息,作者创作时间,作者名、作者邮箱、项目版本号以及配置换将版本等等。
1.在File->Setting->Editor→File and Code Templates选择Includes→点击新建name为“File Top”
在File Top中输入以下代码(可根据自己信息更改)
/*
* Copyright (c) 2020, ${YEAR}, keyila All rights reserved.
*
*/
2.在Includes中找到File Header(系统会自动创建好里面是空白的),在右窗口中输入以下代码。(根据自己的信息更改)
/**
*
* <p>Project: ${PROJECT_NAME} - ${NAME}
* <p>Powered by keyila On ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}:${SECOND}
*
* @author keyila [[email protected]]
* @version 1.0
* @since 17
*/
3.完成Includes的操作后,点击旁边的Files并找到Class,在左边添加File Top。因为当你完成File Top的获取后,窗口右边会自动获取你填写的内容,但不会获取File Top的内容,需要你自己去添加。Class里的所有代码如下
#parse("File Top.java")
#if (${
PACKAGE_NAME} && ${
PACKAGE_NAME} != "")package ${
PACKAGE_NAME};#end
#parse("File Header.java")
public class ${
NAME} {
}
4.添加完成后进行测试。(开头已经测试过了)
5.方法注释,在File->Setting->Editor→ Live Templates点击右边"+"选择新建组(自己起组名)
6.创建组后,再点击“+”创建快捷键方法注释。这里创建的还是类注解代码如下
/**
*
* <p>Description:
* <p>Class:$cname$
* <p>Powered by &user$ on $y$-$m$--$d$ $time$
* @author $user$ [[email protected]]
* @version 1.0
* @since 17
*/
写完代码后记得在左下角选择适用于java,完成后点击右边的Edit Template
接着配置Edit Template如图所示
7.配置完成后,进行测试。这里设置的快捷键是“cc”,可根据自己习惯,自己输入快捷键。按"cc"再按回车键
8.在配置一个常用的快捷键,每次写一个方法可以快速添加注释。同样在在File->Setting->Editor→ Live Templates点击右边"+",然后命名快捷键。完成后代码如下
/**
* Description:
* @date:$Date$ $Time$
* @params:$params$
* @return:$return$
*/
记得选择change选择适用于为java,并点击右边的Edit Template
9.测试运行。这里设置的快捷键是“mm”并点击回车