命名指南:有主见(且基本正确)
本文提出了一套关于代码命名的原则性指南,强调命名应清晰传达意图而非实现细节。作者基于多年经验,指出好的命名能显著提升代码可读性与维护性,并分享了如何避免常见命名陷阱的实用建议。
背景速读
- 作者 Adam Tornhill 是瑞典软件分析师,以《代码中的软件工程》《Your Code as a Crime Scene》等著作闻名,专攻代码分析与心理学交叉领域。他同时也是行业工具 CodeScene 的创始人。
- 这篇指南讨论的是编程中"命名"这一看似基本、实则极难做好的问题。作者认为,好的命名直接影响代码可读性、团队效率和长期维护成本。
- Tornhill 的观点反对教条化的命名规范(如严格遵循 Java/Swift 的惯用风格),而主张基于人类认知心理学来命名——例如变量名应表达其"why"(为何存在)而非"what"(类型信息),因为人的工作记忆有限。
- 文章还批评了"不要注释,让代码自解释"这种极端观点,认为注释和有意义的名字各有不可替代的角色,尤其是在传达设计意图和不可能被代码本身表达的业务逻辑时。