知识卡片

普通读书笔记卡 · 1292.g.1.j · 生成模型:未记录

一致约定减少重复辨认

理解等级:中级

编码约定只有能被识别并持续使用,才会减少读者逐处重新猜测的负担。约定既可涉及名称和注释形式,也可涉及数据归属与公共/内部函数的分工。

一致性帮助读者迁移已经学会的规则,不保证约定本身正确;遇到不适合的场景仍需明示例外,不能把统一形式当正确性证明。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • · 查看原书依据

      一旦我们在一处看到它,我们就可以在别处识别它并理解它的作用。因此,一致性也促进了代码的可读性和简洁性。本书中的两个形式约定的例子是注释的写法以及和数据结构相关联的操作的命名方式。两个概念上的约定例子是在数据结构中管理数据的方式以及把静态函数当做私有函数使用,也就是,它们不属于公共接口部分。

    参考来源

    - 位置:《算法精解:C语言描述》第1章《小酌软件工程》(spine1181;extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part1149.html;u017-ch01-011)。 - 结论依据:17一致性段说同一约定可在不同位置被识别,列名称/注释与数据/内部函数两层;卡片据此解释复用辨认规则的收益。 - 原始内容:一旦我们在一处看到它,我们就可以在别处识别它并理解它的作用。因此,一致性也促进了代码的可读性和简洁性。本书中的两个形式约定的例子是注释的写法以及和数据结构相关联的操作的命名方式。两个概念上的约定例子是在数据结构中管理数据的方式以及把静态函数当做私有函数使用,也就是,它们不属于公共接口部分。