知识卡片

普通读书笔记卡 · 1915.b.2.a

意图注释可暴露实现矛盾

理解等级:中级

说明代码想达到的结果,可以与实际步骤相互检查。若注释写先显示高价商品,而代码把已按高价优先的序列反向遍历,读者就能看到意图与实现冲突。仅把循环翻译成反向遍历则看不出这个问题。意图注释是阅读辅助,仍须保持同步,不能替代能执行的测试。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • · 查看原书依据

      冗余检查的角色。 最终来讲,最好的冗余检查是单元测试(参见第14章)。但是在你的程序中写这种解释意图的注释仍是值得的。

    参考来源

    - 位置:《编写可读代码的艺术》让意图与实现形成交叉检查(spine 2810;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2734.html`;来源键`s2810-ch06-005`)。 - 结论依据:本项正文与图132..158完整实读;按图核对参数、边界与返回索引,不把教学片段当完整实现或已执行测试。 - 原始内容:冗余检查的角色。 最终来讲,最好的冗余检查是单元测试(参见第14章)。但是在你的程序中写这种解释意图的注释仍是值得的。