知识卡片
注释代码不应充当长期备份
旧实现长期以注释保留,读者难判断它仍有计划用途还是早已废弃,容易形成不敢清理的残留。若该版本已被可靠记录,可在当前源码移除无效分支,让历史承担恢复用途。尚未提交、被排除或丢失的历史并不会由版本工具自动保存,因此清理前要辨认范围;这与保留解释“为何不用某方案”的短说明不同。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
- · 第4章 注释
原书出处 · 2 处
- 第4章 注释 4.4.9 位置标记 · 查看原书依据
这些系统可以为我们记住不要的代码
- 第17章 味道与启发 第17章 味道与启发 · 查看原书依据
源代码控制系统还会记得它
参考来源
- 位置:《代码整洁之道》全书 · 第4章 注释,spine013单元008;来源项目book-sources,extracted/代码整洁之道/_epub-src/OEBPS/Text/part0011.xhtml。
- 结论依据:原文两段注释代码及无人敢删的困惑支持不以源码注释作备份;“删了绝不丢”限定为确有可恢复版本记录。未在本机运行示例或改变环境。
- 原始内容:们已经拥有优良的源代码控制系统如此之久,这些系统可以为我们记住不要的代码。我们无需再用注释来标记,删掉即可,它们丢不了。我担保。