一段干净的代码,你在阅读、重用和重构的时候都能非常轻松。编写干净的代码非常重要,因为在我们日常的工作中,你不是仅仅是在为自己写代码。实际上,你还需要考虑一群需要理解、编辑和构建你的代码的同事。
1. 变量
使用有意义的名称
变量的名称应该是可描述,有意义的, JavaScript 变量都应该采用驼峰式大小写 ( camelCase) 命名。 // Don't ❌const foo = "JDoe@example.com";const bar = "John";const age = 23;const qux = true;// Do ✅const email = "John@example.com";const firstName = "John";const age = 23;const isActive = true 布尔变量通常需要回答特定问题,例如: isActive didSubscribe hasLinkedAccount
避免添加不必要的上下文
当对象或类已经包含了上下文的命名时,不要再向变量名称添加冗余的上下文。 // Don't ❌const user = { userId: "296e2589-7b33-400a-b762-007b730c8e6d", userEmail: "JDoe@example.com", userFirstName: "John", userLastName: "Doe", userAge: 23,};user.userId;// Do ✅const user = { id: "296e2589-7b33-400a-b762-007b730c8e6d", email: "JDoe@example.com", firstName: "John", lastName: "Doe", age: 23,};user.id;
避免硬编码值
确保声明有意义且可搜索的常量,而不是直接插入一个常量值。全局常量可以采用 SCREAMING_SNAKE_CASE 风格命名。 // Don't ❌setTimeout(clearSessionData, 900000);// Do ✅const SESSION_DURATION_MS = 15 * 60 * 1000;setTimeout(clearSessionData, SESSION_DURATION_MS);
2. 函数
使用有意义的名称
函数名称需要描述函数的实际作用,即使很长也没关系。函数名称通常使用动词,但返回布尔值的函数可能是个例外 手把手教你uniapp和小程序分包(图文) 学会javascript之迭代器 |