说说程序员注释那些事

     离开园子好久了，从15年就再也没有写过博客了，有时候很想写博客可惜一直被生活的种种事情弄的没有时间来写。一直热爱编程事业，可以毕业后生活中太多事情分散了自己的精力。2013年毕业，2014年结婚，2015年买车生小孩，2016年买房。虽然自己现在是一个团队的leader，但是最近半年家庭生活出现了一些事情，使得自己对于技术的研究太少，心中有种莫名的恐惧感。

    今天参加了吉日嘎拉老师的架构培训，看到老师对于编程的执着和热爱，加上自己最近遇到的问题有感而发，决定写下这篇博客。谈谈对于程序员对于注释的编写。

亲身经历的程序员注释的坑

  最近让我非常郁闷，遇到了一个由于程序员不负责任的代码注释造成的。我到现在的公司一直从事着一些生成算法的问题，9月3号由于接到一个非常紧急的任务需要生成一套码制，这个码制中有两位数码的校验码，其中校验码的算法，项目组直接给到了源码，新的码制需要在9月5号能够在生产系统进行使用，源码的注释如下:

结果在老系统中，该算法被使用的时候参数传递的却是月日，而且这个算法的编写和调用均是同一个人。而我按照年月参数生成的校验码的数码在老系统不能进行正常解码。最后导致公司直接经济损失1万块，而我也被公司进行了批评，被罚款。对于谁应该去对这个事情负责，我想继续探讨下去也没有意义，我只想说程序员应该对自己的代码负责任，做一个有责任的人，如果不对自己的代码有责任心，那么你的注释有还不如没有。

1.及时添加代码注释

2.代码的注释应该简洁

3.代码的注释一定要准确，否则这个注释有还不如没有

4.修改代码后，及时修改注释，并填写修改记录注释。很多程序员在修改代码后由于时间关系，并不能及时修改注释，导致注释最后的注释完全错误。

5.代码及时review

6.对自己的代码带上责任感

 

转载于:https://www.cnblogs.com/ITCommunication/p/6218704.html