添加注释时的一点建议

来源：

沈阳市和平区爱尚职业培训机构

发表于：2018-09-26 16:56:31

相关标签：软件开发培训沈阳软件开发培训

添加注释时的一点建议

在类中，接口等必须有创建时间，创建人，版本号，描述等注释。
注释不是越多越好，比如：get/set方法就不需要写注释。更不需要每一行都写注释。
注释需要写的简明易懂。特别是方法的参数，以及返回值。
每一次修改时，相应的注释也应进行同步更新。
在类，接口，方法中，应该都使用/** */javadoc注释。因为这样调用者就不需要进入方法内部才知道方法的用处。提高编码效率。
方法代码中如果有顺序之分，好将代码也加上序号，如1，2，3等。
枚举中的每一个值都需要添加注释。
小结

写注释是一个好习惯，能让自己和团队都受益，如果你接手一个一丁点注释都没有的项目，那么上一个程序员就倒霉了(此处省略N个字)，不知你们有没有看过开源项目的源码，那注释写的相当详细，大家可以多多参考，争取别做一个”倒霉”的程序员。

参加沈阳爱尚java培训，学专业实用的java课程，爱尚教育集团，2010年成立，在全国多城市设有分校，爱尚实训，秉承做品质教育用事实说话的办学理念，多年来成果为企业输送java开发人才近千人，爱尚实训独有实训理念，使学生深受用人单位好评，爱尚实训，口碑口口相传，因此有越来越多的企业与爱尚实训合作，爱尚实训品质保证，入学签订就业协议，对学员进行终身就业跟踪指导，一次收费，终身就业

文中图片素材来源网络，如有侵权请联系删除

分享到：

添加注释时的一点建议 原创内容，请点击沈阳软件开发培训

学习课程：