用过Eclipse的小伙伴一定都知道Eclipse的注释,好的注释可以更好的帮助我们规范代码,当然IDEA也是有注释的,今天小编就来说下IDEA开发工具是如何设置注释的。
(一),类注释设置
1.Eclipse中常用的类注释:
/**
* @ClassName: ${type_name}
* @Description: ${todo}
* @author changqing.zhou
* @date ${date} ${time}
*
*/
2.我们可以把它设置到IDEA中,IDEA在创建类的时候会自动添加注释,首先选择File——》Settings
3.然后选择 Editor——》Fil and Code Templates——》Files——》Class
4.将注释类放到class文件里,点击ok就可以了。
(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名
(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述
(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}。
(二),方法注释
1.Eclipse中方法的注释:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* @author changqing.zhou
* @date ${date} ${time}
*/
2.IDEA中还没有自动注释方法的功能,这里我们还是按照自己的习惯设置,在eclipse中快速创建方法注释是:/**+Enter,这里我们还是按照这个习惯来设置,还是选择 File——》Settings
3.然后选择 Editor——》Live Templates
4. 单击右键加号,选择Template Group
(1)新建组:命名为userDefine
2)新建模板:命名为*
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为
/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、
获取方法返回值的methodReturnType()
(3)设置生成注释的快捷键,选择userDefine——》Live Template
(4)设置模板:模板内容如下
注意第一行,只有一个*而不是/*
在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名
/**
* @Title: $file_name$
* @Package $package_name$
* @Description: $todo$
* @author changqing.zhou
* @date $date$ $time$
* @return $return$
*/
(5)设置模板的应用场景
点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere-->Java即可
(如果曾经修改过,则显示为change而不是define)
(6)设置参数的获取方式
选择右侧的Edit variables按钮
注意:第五步和第六步顺序不可颠倒,否则第六步将获取不到方法
选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多教程说获取param时使用脚本的方式,我试过使用脚本
的方式不仅麻烦而且只能在方法内部使用注释时才能获取到参数
5.效果展示,是不是灰常简单。