代码注释是良好的开发习惯表现之一,如何能写好注释?给个注释模板如下:
注释示例
虽然定义了注释模板,如果让开发人员一个字符一个字符敲显得比较笨拙,复制粘贴又显得不那么优雅,所以我们的目标是优雅的自动生成注释。
借助Eclipse工具来实现优雅的自生成注释模板
1.打开eclipse工具栏Windows-->Preferences-->Java-->Code Style-->Code Templates
编辑注释
2.可以添加方法、类、Setters、Getters的相关注释,下图示例是为所有的类添加注释模板。
编辑类注释
3.添加完相应模板后,点击OK保存。 所以java类,在通过eclipse快捷捷【/** + 回车】即可生成指定样式的注释
注释模板复用
如果项目组所有开发人员都需要手工编辑这些注释模板,也显得不够优雅,如果能“一处定义,多处使用” 似乎更符合我们的需求。
1.导出注释模板
导出注释模板
2.导入注释模板
通过导入注释模板,免去每次编辑的重复劳动。
导入注释模板
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。