《代码大全2》阅读笔记2

工匠技艺篇——编写高可读性代码
阅读章节： 第七部分：软件工艺 (第14-19章)

核心摘要：
本篇笔记深入探讨了《代码大全2》中关于“代码即文档”的核心技艺。它强调，代码的首要读者是人，其次才是计算机。 因此，变量命名、语句组织、代码结构等一切活动的最高目标都是最大化可读性。

关键要点与感悟：

自文档化的代码：

观点： 优秀的代码自身就是最好的文档。通过清晰的命名、良好的结构和恰当的注释，代码应该能够清晰地表达其意图和逻辑。

感悟： 我曾经写过很多只有我自己能看懂的“聪明”代码。现在，我追求的是“显而易见”的代码。例如，将 d 改为 elapsedTimeInDays，其含义不言自明。

变量命名的艺术：

观点： 命名是 фундаментальный（基础性的）。好的名字应该完全、准确地描述变量所代表的事物，并具备适当的长度和清晰度。

感悟： 书中提供的命名规则（如避免模糊的名字、使用对仗词等）非常实用。我开始有意识地检查自己的命名，问自己：“三个月后，别人（或我自己）看到这个名字，能立刻明白它是什么吗？”

控制结构与代码布局：

观点： 使用线性的、清晰的控制流（如 if-else），避免复杂的嵌套。代码的物理布局（缩进、空行、括号位置）对可读性有直接影响。

感悟： 我开始坚持使用“早返回”（Early Return）策略来减少嵌套深度，并使用统一的代码格式化工具。干净的代码布局就像干净的桌面，能让人心情舒畅，思路清晰。

实践启示：

制定并遵守团队的编码规范，包括命名约定、注释规范和格式标准。

在代码审查中，将“可读性”作为首要审查指标之一。如果审查者需要花费大量精力去理解一段代码，那么这段代码就需要改进。