知识卡片
注释也是代码
内容
注释的目的应是提高可读性,而不是堆积解释;注释必须精确描述代码,失真的注释比没有注释更危险,因为它会让维护者相信错误的上下文。发散:代码评审不能只看逻辑,也要核对注释是否仍与当前实现一致,过期注释应当被当作 bug 处理。
参考来源
- 位置:《JavaScript语言精粹(修订版)》第2章《语法 Grammar》"空白"一节
- 结论依据:原文说明注释应优先用于提高可读性,并特别强调"注释一定要精确地描述代码,没有用的注释比没有注释更糟糕",由此可以推出失真注释比缺失注释更危险的结论。
- 原始内容:注释应该被优先用来提高程序的可读性。请注意,注释一定要精确地描述代码。没有用的注释比没有注释更糟糕。