知识卡片
注释需要随所指代码共同维护
注释与代码各自保存一份信息,移动、修改或复制其中一份后,另一份可能失去对应。HTTP日期例的解释被其他字段隔开,就增加了定位与维护成本。读者应核对实现和适用条件,而不是因为有注释就相信它;这也不意味着所有注释都是失败,代码未显露的理由与约束仍值得说明。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
- · 第4章 注释
原书出处 · 4 处
- 第4章 注释 第4章 注释 · 查看原书依据
注释并不总是随之变动
- 第17章 味道与启发 第17章 味道与启发 · 查看原书依据
最好尽快更新或删除掉
- 附录B org.jfree.date.SerialDate 附录B org.jfree.date.SerialDate(续) · 查看原书依据
public abstract boolean isAfter(SerialDate other);
- 附录B org.jfree.date.SerialDate 附录B org.jfree.date.SerialDate(续) · 查看原书依据
public boolean isAfter(final SerialDate other)
参考来源
- 位置:《代码整洁之道》全书 · 第4章 注释,spine013单元001;来源项目book-sources,extracted/代码整洁之道/_epub-src/OEBPS/Text/part0011.xhtml。
- 结论依据:原文展示日期常量与样例被字段分隔,并反复指出旧注释失准,支持维护对应关系,不接受“注释总是失败”的绝对评价。未在本机运行示例或改变环境。
- 原始内容:那里。彼此分离、重造又合到一处。很不幸,注释并不总是随之变动——不能总是跟着走。注释常常会与其所描述的代码分隔开来,孑然飘零,越来越不准确。例如,看看以下注释以及它本来要描述的代码行变成了什么样子: MockRequest req