为什么要添加程序注释?至少有如下三方面的考虑。
- 永远不要过于相信自己的理解力!当你思路通常,进入编程境界时,你可以很流畅地实现某个功能,
但这种流畅可能是因为你当时正处于这种开发思路中。为了在再次阅读这段代码时,还能找回当初
编写这段代码的思路,建议添加注释!
- 可读性第一,效率第二!在那些“古老”的岁月里,编程是少数人的专利,他们随心所欲地写程序,
他们以追逐程序执行效率为目的。但随着软件行业的发展,人们发现仅有少数技术极客编程满足
不了日益增长的软件需要,越来越多的人加入了编程队伍,并引入了工程化的方式来管理软件开发。
这个时候,软件开发变成团队协同作战,团队成员的沟通变得很重要,因此,一个人写的代码,需
要被整个团队的其他人所理解;而且,随着硬件设备的飞速发展,程序的可读性取代执行效率变成
了第一考虑的要素。
- 代码即文档!很多刚刚学完学校软件工程课程的学生会以为:文档就是 Word 文档!实际上,程序
源代码是程序文档的重要组成部分,在想着把各种软件相关文档写规范的同时,不要忘了把软件里
最重要的文档————源代码写规范!
---内容转于《疯狂Java讲义》
为什么要添加程序注释?
原文:https://www.cnblogs.com/qqdssjy/p/14107941.html