一、设置IDEA中类的模板(IDEA中创建类时会自动添加注释):
1.File->Settings->Editor->File and Code Templates->Files
2.选择Class文件(设置接口时选择Interface)
(1)${NAME}:设置类名,与下面的${NAME}一致才能获取到新创建的类名;
(2)TODO:待办事项的标记,一般新创建的类或方法都需要添加简要的描述(功能用途等);
(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些是IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME};
(4)@Version:设置版本号,一般新创建的类默认是1.0版本
/**
* @ClassName ${NAME}
* @Description TODO
* @Author ${USER}
* @Date ${DATE} ${TIME}
* @Version 1.0
**/
(5)效果截图:
二、设置方法注释模板
在IDEA中设置自定义注释
1.File->Settings->Editor->Live Templates
(1)新建组,命名为userDefine:
(2)新建模板,命名为*
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为
/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、
获取方法返回值的methodReturnType()
(3)设置生成注释的快捷键:
(4)设置模板
/**
* @Description: $description$
* @Param: $params$
* @return: $returns$
* @Author: Mr.Zeng
* @Date: $date$ $time$
**/
(5)设置模板的应用场景
点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere-->Java即可
(如果曾经修改过,则显示为change而不是define)
(6)设置参数的获取方式
选择右侧的Edit variables按钮
@Param:methodParameters();
@return: methodReturnType();
@date: date();
@time: time();
(7)效果图:
其他自定义快捷键设置流程类似(如syso:System.out.println();)。