编写干净、可理解和可维护的代码是每个开发人员必须掌握的关键技能。
在这篇文章中,我们将着眼于提高代码质量的最重要的原则,并为您提供每个原则的代码示例。
大多数例子都取自Robert J. Martin的《Clean Code》。这是一本编程经典,如果有时间,建议阅读全文。
1. 创建有意义的变量名
不要使用注释去解释一个变量名的定义,如果一个变量需要用注释,我们应该考虑如何重命名,使我们的变量更表意。
"A name should tell you why it exists, what it does, and how it is used. If a name requires a comment, then the name does not reveal its intent." – Clean Code
Bad example:
var d; // elapsed time in days
Good example:
var elapsedTimeInDays;
var daysSinceCreation;
var daysSinceModification;
2. 避免歧义
小心那些有特定含义的词。例如不要将帐户分组命名为accountList,除非它的type确实是List。这个词有特定的含义,它可能会导致错误的结论。
即使type是list,比起accountList, accounts是一个更好的选择
3. 避免无意义的单词(噪声词)
噪声词是指不提供关于变量的任何附加信息的词。它们是多余的,应该删除。
一些使用频繁的噪声词:
- The (prefix)
- Info
- Data
- Variable
- Object
- Manager
如果你定义的变量名是userInfo,你可以直接修改为user; 如果你定义的方法名是getOrderData,你可以直接命名为getOrder。去掉这些噪声词,依然不影响我们根据变量名来理解所定义的变量的意义,而且我们的变量名也变得更加简洁。