关于代码注释的危害

在这里插入图片描述
在github的LTP项目(一个linux内核测试项目)的文档看到这么一句话不很理解,关于代码注释的危害.

在这里插入图片描述

我印象中不是鼓励大家进行代码注释嘛?这里面说Comments more harm than good 。
原因 :comments and actual implementation were drifting slowly apart
结果:API misuses and hard to find bugs.

通俗的讲,就是如果你给了错误注释,注释的内容与实际代码所做的内容相差甚远,会误导到其他使用到这段代码的人。
错误的文档往往比没有文档跟糟糕,因为这会把使用者引向错误的导向。

1000道程序员常见问题解析是最近新整理的一个专栏,欢迎大家提供问题与思路。
所有问题、思路、答案将整理在公众号,大家可以扫码关注一下,相互交流学习。
在这里插入图片描述
关注即可免费领取一份2020技术学习提升大礼包!(含文档、电子书、视频等等)

发布了20 篇原创文章 · 获赞 258 · 访问量 3万+

猜你喜欢

转载自blog.csdn.net/lingshengxueyuan/article/details/103898906