养成随时注释的好习惯

简介: 打从学习编程开始,就知道注释的重要性。逻辑比较复杂的代码;修改代码逻辑;或是加上新的功能等等,最好加上注释。在程序开发、代码维护时我也一直贯彻着这样的思想。可是有时候你还是会忽略它,有时候是因为赶进度,不想花费额外的时间注释;有时候是因为对逻辑理解比较透彻,觉得没有必要注释.....须不知对别人来说,这段代码的逻辑可能不甚了解,也许对你自己而言,几个月或是半年过后,你还能自信满满的说“我对这些逻辑一清二楚”吗? 今天我就遇到了这样一件事件。

  打从学习编程开始,就知道注释的重要性。逻辑比较复杂的代码;修改代码逻辑;或是加上新的功能等等,最好加上注释。在程序开发、代码维护时我也一直贯彻着这样的思想。可是有时候你还是会忽略它,有时候是因为赶进度,不想花费额外的时间注释;有时候是因为对逻辑理解比较透彻,觉得没有必要注释.....须不知对别人来说,这段代码的逻辑可能不甚了解,也许对你自己而言,几个月或是半年过后,你还能自信满满的说“我对这些逻辑一清二楚”吗? 今天我就遇到了这样一件事件。让我深刻的认识到了忽略注释的代价。今天早上老大叫我过去,过去才知道自己几个月前时候修改了一段代码,现在发现它带入了一些错误,老大也不了解我为什么这样修改,只能把我这个始作俑者叫去“质问”一番,我瞄了一下代码,也实在想不起来,当时是出于什么动机、业务逻辑这样修改。自己在哪里使劲想也想不起来。真是汗啊!!,幸亏自己有个好习惯,在修改一段代码前,都会先复制原来的代码,然后注释,然后在复制的代码上做修改。幸亏自己这样做了,否则真的连原来的逻辑都很难还原(如果没用源代码管理器或是存储过程之类的代码)。所以以后一定要养成必要地方随时注释的好习惯。这样对代码可读性、维护方面都有好处。

相关文章
|
1月前
|
算法 开发者
养成良好的书写习惯,让你的代码变优雅的一些小技巧
养成良好的书写习惯,让你的代码变优雅的一些小技巧
14 0
|
6月前
|
程序员
程序员爱写不写注释的智慧
程序员爱写不写注释的智慧
47 3
|
程序员 开发者
程序员内心独白:注释,爱恨交加,双标难舍
程序员内心独白:注释,爱恨交加,双标难舍
|
敏捷开发 设计模式 SQL
如何养成整洁的代码习惯
如何养成整洁的代码习惯
100 1
|
运维 监控 Dubbo
写代码需要养成的好习惯
写代码需要养成的好习惯
100 0
|
程序员 API 数据库
想要写出好味道的代码,你需要养成这些好习惯!
大家好,我是小羽。无论做什么行业,良好的习惯会让我们受益终生。它就如我们的指南针一样,指引着我们的行动,从而走向成功。养成良好的习惯,会让我们的工作更加顺利,生活也会变的更加清晰。当我们久...
181 0
想要写出好味道的代码,你需要养成这些好习惯!
程序人生 - 如何养成学习的习惯?
程序人生 - 如何养成学习的习惯?
102 0
|
程序员
都说代码注释是程序员必备技能,但是你这注释也太奇葩了吧!
都说代码注释是程序员必备技能,但是你这注释也太奇葩了吧!
151 0
都说代码注释是程序员必备技能,但是你这注释也太奇葩了吧!