编写高质量代码之命名技巧

学习笔记
  495字   1分钟

1.不使用没有任何意义的英语字母进行命名

1
2
3
for(let i=0; i<10; i++) {
    //...
}

应该表明这里 i 的用途是什么，比如是遍历元素，可以使用 index

2.不使用拼音或拼音首字母组合

1
2
cishu = 5;  // 循环的次数
zzje = 1000.00;  // 转账金额

3.方法名的命名，需要使用 “动宾结构短语” 或 “动词+表语结构短语”

如果宾语是一个集合，最好是使用复数

1
2
3
4
createOrder();	// good
orderCreate();	// bad
removeOrders();	// good
removeOrder();	// bad

4.常见的 “增删改查” 方法，命名要谨慎

  • 增加：最常使用的是 create 和 add，但最好根据英语语义进行区分，这样有助于理解，create 代表创建，add 代表增加。比如，要创建一个 Student，用 createStudent 比用 addStudent 好
  • 修改：常见的有 alter、update、modify，个人觉得 modify 最准确
  • 查询：对于获取单个对象，可以用 get。对于条件查询，用 search （最好不用 find，find 在英文里强调结果，是 “找到” 的意思），你提供的 “查询”方法，不能保证输入的条件总能 “找到” 结果
  • 删除：常见的有 delete 和 remove，但建议使用 delete，因为 remove 有 “移动” 的意思

5.宁愿方法名冗长，也不要使用让人费解的简写

比如要写这样一个方法：判断支付账户是否与收款账户相同

1
2
checkIsOrderingAccCollAccSame(...);	// bad
isOrderingAccountSameAsCollectionAccount(...);	// good

虽然第二个有点长，但相对第一个来说会比较容易阅读

6.成员变量不要重复类的名称

有些人喜欢在 Account 对象的成员变量中使用 accountId、accountNumber 等命名，其实是没有必要的，你引用 accountId，必须得 Account.accountId，用 Account.id 就足够清晰了

原文：https://kb.cnblogs.com/page/522021/

读了原文后觉得非常好，有一些命名错误是自己以前也犯过的，故用自己的话过滤一下输出成文章，把经验分享给更多人