知识卡片

普通读书笔记卡 · 6991.r.2.m · 生成模型:未记录

说明应靠近事实的维护来源

理解等级:中级

setFitnessePort只保存传入值,却在注释承诺默认8082,默认值真正变化时这里未必有人同步。实现并不掌握的系统事实,应在其真实来源维护,再通过稳定引用或统一配置让读者找到。就地说明仍可提相关约束,但要明确它依赖哪里,避免多处独立抄写同一默认值。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《代码整洁之道》全书 · 第4章 注释,spine013单元009;来源项目book-sources,extracted/代码整洁之道/_epub-src/OEBPS/Text/part0011.xhtml。 - 结论依据:原文setter与远处默认值对照直接展示非本地信息漂移,支持按事实归属安排说明,不是禁止所有跨模块背景。未在本机运行示例或改变环境。 - 原始内容:之外,它还给出了有关默认端口的信息。不过该函数完全没控制到那个所谓默认值。这个注释并未描述该函数,而是在描述系统中远在他方的其他函数。当然,也无法担保在包含那个默认值的代码修改之后, 这里的注释也会跟着修改。 /** * Port on wh