每日PR保持代码整洁自查表

如今，公司对软件工程师（主要是高级工程师）最迫切的需求之一，是以迭代和增量的方式提供高质量的代码审查。

这意味着在每次 PR 审查中，开发人员被要求反复提高即将合并代码的质量。

在这篇文章中，我将尝试指出开发人员在进行重构或审查时应牢记的基本原则。

让我们逐个主题来看这些点：

1. 命名

• 有明确意图的命名：方法或变量名应该在查看代码实现之前就能解释其意图。
• 类名应该是名词或名词短语。
• 方法名应该是动词。
• 为每个概念选择一个词：get、retrieve、fetch 是相似的，选择一个统一使用它。
• 使用计算机科学术语：例如，AccountAdapter 对程序员来说意味着适配器模式，如果没有相关的计算机科学名称，则使用面向问题的名称。
• 使用可搜索的名称：在 IDE 中搜索特定短语会更容易。