使用有意义、可读性好的变量名

能让别人易于阅读,也能让自己重构代码时更容易自己想到具体是做什么的。做到见名知意。

  1. let y = new Date().getFullYear(); // ❌
  2. let currentYear = new Date().getFullYear(); // ✔️ 一看就知道是获取当前的年份

避免多余、重复的描述

当定义的对象或变量本身已经有意义时,命名时就不再重复或添加一些多余的不用字段

  1. let nameValue = 'Sylar'; // ❌
  2. let name = 'Sylar'; // ✔️
  3. let Person = { // ❌
  4. personName: 'Sylar',
  5. personAge: 18
  6. }
  7. let Person = { // ✔️ 代码更加简洁易读
  8. name: 'Sylar',
  9. age: 18
  10. }

使用易于检索的变量名

  1. // ❌ 会让人困惑这个86400000是什么意思,也不利于检索
  2. for (let i = 0; i < 86400000; i++) {
  3. doSomething();
  4. }
  5. // ✔️ 把这个数字变成一个常量,增加代码的易读性
  6. const MILLISECOND_IN_A_DAY = 86400000;
  7. for (let i = 0; i < MILLISECOND_IN_A_DAY; i++) {
  8. doSomething();
  9. }

避免无意义的条件判断

  1. // ❌ 如果名字不存在就给一个默认值
  2. function assignment(name) {
  3. let result;
  4. if (name) {
  5. result = name;
  6. } else {
  7. result = 'Sylar';
  8. }
  9. }
  10. // ✔️ 可以通过一行代码来实现
  11. function assignment(name) {
  12. let result = name || 'Sylar';
  13. }
  14. // ✔️✔️ 或用ES6的默认值来实现
  15. function assignment(name = 'Sylar') {
  16. ...
  17. }