生成类注释
File–>settings–>Editor–>File and Code Templates–>Class
(1)@BelongsProject:当前项目的名称
(2)@BelongsPackage:当前包的名称
(3)@Author:作者姓名(可以写死,写成你的名字)
(4)@CreateTime:该类创建的时间
(5)@Description:对该类的描述(该类的功能)
(6)@Version:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了
/**
*@BelongsProject: ${PROJECT_NAME}
*@BelongsPackage: ${PACKAGE_NAME}
*@Author: yanhongwei
*@CreateTime: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*@Description: TODO
*@Version: 1.0
*/
生成方法注释
创建模板
File–>Settings–>Editor–>Live Templates
提示:这里Abbreviation:是设置你要生成这个注释的快捷方式,我是简写的注释(zs),这样我每次在方法是只用打zs+Enter就会自动为方法生成注释,你可以根据你自己的爱好来设置不同的快捷键
注意:这里要编辑配置一些这些变量,在设置参数名时必须用参 数 名 {参数名}参数名的方式,否则这里读取不到你设置的参数名
设置模板的应用场景
点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可,如果曾经修改过,则显示为change而不是define
验证方法注释
设置成功后点击OK,返回项目新建一个方法,写完入参和返回值以后,在方法上面:输入 zs然后回车
总结
好好设置你的注释模板,记得写代码一定要写注释,写注释,写注释,重要的事情说三遍,写注释是一个开发人员最基本的职业素质呀,大家可以根据自己的爱好和风格去设置,加油!!!
原文地址:https://www.cnblogs.com/wzljava/p/16607132.html
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。