知识卡片
公开方法扩大维护契约
一个只读辅助方法即使实现简单,公开之后也要提供稳定文档、必要的前置检查和测试,并考虑以后的兼容责任。它可能显著改善可观察性,但不能仅因“无副作用”就随意暴露。是否公开,应比较真实客户所需的信息与长期维护成本,而不是只看当前多写了几行代码。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第 7 章 让代码说话:可读性 · 查看原书依据
一个公有方法的额外成本包括: 适当的文档,以描述其契约; 前置条件检查,以应对与可能不正确的客户端的交互; 一整套测试,以保证其正确性。 在我们这个特殊的场景中,这些成本相当有限,因为这三个方法都只有
参考来源
- 位置:《你真的会写代码吗-2021》第7章《让代码说话:可读性》(来源项目book-sources:`extracted/你真的会写代码吗-2021/_epub-src/OEBPS/Text/0017.xhtml`)
- 结论依据:原文以“一个公有方法的额外成本包括”所在的机制、例子或限制条件支撑本文;适用边界及读者推导在正文中单独说明。
- 原始内容:一个公有方法的额外成本包括: 适当的文档,以描述其契约; 前置条件检查,以应对与可能不正确的客户端的交互; 一整套测试,以保证其正确性。 在我们这个特殊的场景中,这些成本相当有限,因为这三个方法都只有