达内广州C++学院|c++培训|广州达内科技C++/C#培训|.NET培训|IT培训|达内广州岗顶中心 达内广州C++学院|c++培训|广州达内科技C++/C#培训|.NET培训|IT培训|达内广州岗顶中心
java程序员
 当前位置:主页 > 高端课程 > java程序员 >

eclipse修改默认注释

时间:2019-06-12  来源:未知  作者:广州达内培训

一、背景简介

丰富的注释和良好的代码规范,对于代码的阅读性和可维护性起着至关重要的作用。几乎每个公司对这的要求还是比较严格的,往往会形成自己的一套编码规范。但是再实施过程中,如果全靠手动完成,不仅效率低下,还难以保证真正的符合规范。所以结合IDE环境,自动生成注释,还是很有必要的。今天我们就说一下,如何使用Eclipse给我们提供的自定义代码模版的功能来作业。

二、设置注释模板

  • 设置注释模板的入口:Window->Preference->Java->Code Style->Code Template

  • 然后展开Comments节点就是所有需设置注释的元素了!

  • 一下修改,只需要点击右侧面板上的按钮 – 编辑(Edit), 便可修改成自己的注释!


三、详细介绍

1、文件(Files)注释标签

Files标签是对新建的文件的说明,出现在文件最上面

  • 推荐注释风格:
/**   
 * Copyright © ${year} eSunny Info. Tech Ltd. All rights reserved.
 * 
 * 功能描述:
 * @Package: ${package_name} 
 * @author: ${user}   
 * @date: ${date} ${time} 
 */

2、类型(Types)注释标签(类的注释)

Types标签是对类Class的一个说明,出现在类上面

  • 推荐注释风格:
/**   
* Copyright: Copyright (c) ${year} LanRu-Caifu
* 
* @ClassName: ${file_name}
* @Description: 该类的功能描述
*
* @version: v1.0.0
* @author: ${user}
* @date: ${date} ${time} 
*
* Modification History:
* Date         Author          Version            Description
*---------------------------------------------------------*
* ${date}     ${user}           v1.0.0               修改原因
*/

3、字段(Fields)注释标签

Fields标签是对变量字段的说明

  • 推荐注释风格:
// @Fields ${field} : ${todo}

4、构造函数(Constructors)标签

Constructors标签是对类的构造函数的说明

  • 推荐注释风格:
/**   
* @Function: ${file_name}
* @Description: 该函数的功能描述
*
* @param:参数描述
* @version: v1.0.0
* @author: ${user}
* @date: ${date} ${time} 
*/

5、方法(Methods)标签

Methods标签是对函数方法的说明

  • 推荐注释风格:
/**   
* @Function: ${file_name}
* @Description: 该函数的功能描述
*
* @param:描述1描述
* @return:返回结果描述
* @throws:异常描述
*
* @version: v1.0.0
* @author: ${user}
* @date: ${date} ${time} 
*
* Modification History:
* Date         Author          Version            Description
*---------------------------------------------------------*
* ${date}     ${user}           v1.0.0               修改原因
*/

6、覆盖方法(Overriding Methods)标签

Overriding Methods标签是对覆盖方法的说明

  • 推荐注释风格:
/** 
* ${see_to_overridden}  
* @Function: ${file_name}
* @Description: 该函数的功能描述
*
* @param:描述1描述
* @return:返回结果描述
* @throws:异常描述
*
* @version: v1.0.0
* @author: ${user}
* @date: ${date} ${time} 
*
* Modification History:
* Date         Author          Version            Description
*---------------------------------------------------------*
* ${date}     ${user}           v1.0.0               修改原因
*/

7、代表方法(Delegate Methods)标签

  • 推荐注释风格:
/**
 * ${tags}
 * ${see_to_target}
 */

8、getter方法标签

  • 推荐注释风格:
/**
 * @return the ${bare_field_name}
 */

9、setter方法标签

  • 推荐注释风格:
/**
 * @param ${param} the ${bare_field_name} to set
 */

四、如何自动添加注释

1、可通过如下三种方法自动添加注释:

  • 输入“/**”并回车。
  • 用快捷键 Alt+Shift+J(先选中某个方法、类名或变量名)。
  • 在右键菜单中选择“Source > Generate ElementComment”。

2、新建文件或类的时候,怎么自动生成文件(file)的注释呢?


备注:只需要勾选Automatically and comments for new methods and types即可,在eclipse中使用你修改的备注内容!

3、导入/导出代码格式模板

如果你辛辛苦苦定制好了自己的代码风格,然后换了台机器进行操作或重装了Eclipse,是不是要重新配置一遍呢?答案当然是No了,Eclipse提供了“导出”和“导入”功能,你可以把自己的模板导出来在其他机器上使用。


五、创建自定义注释模板

  • eclipse自带一些注释模板,如日期(@date)、文件名(@ClassName)、作者(@author)等,那么怎么自定义一些注释模板呢?

 


上一篇:一个妹子的美团面试经历,已成功拿到Offer
下一篇:spring 组件基于注解的注册方式

友情链接:
  • 全球最大晶圆代工半导体制造厂,台积电斥资订购艾斯摩尔机器设备
  • 英特尔依然是那个英特尔,且看英特尔的城防体系
  • 支持双 DRAM 内存接口,慧荣企业级 SSD 主控方案披露
  • 在全球被反垄断罚款,冤!高通到底哪里得罪了欧盟?
  • 强强联合!万业、微电子所和芯鑫共同打造全新半导体设备
  • 复旦大学校长称:对于集成电路产业发展,大学应该主动担当
  • 技术再升级!无锡中科芯攻克晶圆级再布线及晶圆级凸点制备关键技
  • 聚力!万业企业设立集成电路装备集团,提供自主可控设备
  • 德州仪器C2000微控制器增强连通性和控制性
  • 英特尔打出降价策略,以免被竞争对手 AMD 打败?
  • 贸易摩擦的闹剧没有赢家,苹果有勇气离开中国吗?
  • 图像信号与视觉处理器的发展趋势
  • 真干快消品定位方案班(第二期)火热开班
  • Java集合 ArrayList原理及使用
  • TDD(测试驱动开发)死了吗?
  • JAVA基础之XML相关
  • javaweb项目搭建ehcache缓存系统
  • 每日一码——字符串统计
  • 一篇文章帮你彻底搞清楚“I/O多路复用”和“异步I/O”的前世今生
  • 九:模板方法模式
  • 十二:命令模式(人员解耦和)
  • Java 转PPT为图片、PDF、SVG、XPS、ODP以及PPT和PPTX互转
  • SpringCloud学习(SPRINGCLOUD微服务实战)一
  • 记一次微信网页授权后获取用户信息并重定向
  • 速途新营销五点实战洞察解码“品效合一”
  • 十一:外观模式详解(Service,action与dao)
  • 手把手教你学会 基于JWT的单点登录
  • mysql锁机制总结,以及优化建议
  • 解决多个版本jar包冲突【jar内包名重命名】
  • 中国首张5G终端电信设备进网许可证 华为Mate 20 X 5G版入网
  • RPC之Thrift
  • 高级Java工程师必备 ----
  • 天猫618期间实物支付GMV增长38.5%
  • 换季了,老板你的库存处理好了吗?
  • 从“618”大数据看中国消费新活力
  • 小米生态链:贵在格局感与收放度
  • CODING 2.0 企业级持续交付解决方案
  • 老铁奇趴“新京济” 快手*京东618战报出炉
  • 中小企业新媒体运营基本技能
  • 上汽大通房车再度携手LINE FRIENDS 魔都巡游顺利开启
  • 华为高端手机国内市场份额超苹果夺得榜首
  • 中国智能制造分析报告
  • iPlus艾加营销助力腾讯广告牵手吴晓波 推进商业IP变现
  • 2019世界新能源汽车大会7月1日将在海南举行
  • 区域酒企如何转型突围
  • 时时彩论坛
  • 五星体育斯诺克
  • 北单比分直播
  • 河北11选5走势图
  • 福建体彩36选7开奖结果
  • 九龙图库下载