关于代码注释的危害

在这里插入图片描述
在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技术学习提升大礼包!(含文档、电子书、视频等等)

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值