知识卡片

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

变更历史宜保存在版本记录中

理解等级:中级

把每次修改和署名堆在文件头,会让当前实现被过往清单淹没,负责人变化后标签也可能失真。已有可追溯版本记录时,可将时间、作者和变更说明放到适合的记录系统,源码注释集中解释当前技术决策。项目要求保留的来源声明是另一用途;历史能否恢复取决于真实提交及保留范围,不是工具名称的保证。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 3 处

    参考来源

    - 位置:《代码整洁之道》全书 · 第4章 注释,spine013单元006;来源项目book-sources,extracted/代码整洁之道/_epub-src/OEBPS/Text/part0011.xhtml。 - 结论依据:原文长日志与后文Added by Rick显示时间信息和当前阅读分工,支持使用版本历史承载变更,未把所有署名/许可声明等同可删杂物。未在本机运行示例或改变环境。 - 原始内容:5 日志式注释 有人会在每次编辑代码时,在模块开始处添加一条注释。这类注释就像是一种记录每次修改的日志。我见过满篇尽是这类日志的代码模块。 * Changes (from 11-Oct-2001) * ----------------