知识卡片
可维护代码支持局部理解
维护者应能通过局部代码与必要上下文迅速理解职责、数据和约束,而不必先掌握全系统才敢修改。清晰命名、内聚组织和关键依据能降低定位成本。
硬件交互应记录适用数据手册与寄存器依据,最好包含版本和定位。维护成本常可观,但原文“任何代码维护都超过开发”及对维护者能力的轻视不作通则。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 15.6 项目开发 · 查看原书依据
有些人能看懂代码的任何部分,并能迅速理解它的作用。编写无法维护的漂亮代码通常会导致失败。发现使代码容易理解的编程之美。 如果你的代码与硬件通信,那么真正有助于维护者的是在你的代码中包含对硬件数据表的引用。如果你在探究某个寄存器,请在代码中描述该寄存器的数据表页
参考来源
- 位置:《计算机系统解密》15.6 项目开发(来源项目book-sources,源文件:extracted/计算机系统解密/_epub-src/text/part0151.html)
- 结论依据:本项全部正文与图表实际读取,区分作者示例、推导与实现边界;纠错另有明确说明。
- 原始内容:有些人能看懂代码的任何部分,并能迅速理解它的作用。编写无法维护的漂亮代码通常会导致失败。发现使代码容易理解的编程之美。 如果你的代码与硬件通信,那么真正有助于维护者的是在你的代码中包含对硬件数据表的引用。如果你在探究某个寄存器,请在代码中描述该寄存器的数据表页