javascript代码规范是什么_如何写出可读性高的代码

JavaScript代码规范是提升可读性、可维护性与协作效率的约定，涵盖命名（驼峰式、全大写常量、首字母大写类）、结构（单一职责、早期返回、解构）、格式（空格、换行、箭头函数）和注释（重“为什么”轻“是什么”）。

JavaScript代码规范是一套约定俗成或团队统一的书写习惯和约束规则，核心目标是提升代码可读性、可维护性与协作效率。它不决定功能对错，但直接影响别人（包括未来的你）能否快速理解、安全修改和高效调试。

命名清晰，语义准确

变量、函数、类名要能“望文知意”，避免缩写歧义或无意义代号（如 data、temp、fn）。

• 用 驼峰式（camelCase） 命名变量和函数： userName、calculateTotalPrice
• 常量全大写加下划线： MAX_RETRY_COUNT、API_BASE_URL
• 构造函数或类首字母大写： UserProfile、PaymentService
• 布尔值建议用 is、has、can 开头： isValid、hasPermission、canEdit

结构简洁，逻辑分层

单个函数只做一件事，长度控制在20行以内；嵌套层级不超过3层；复杂逻辑及时拆解为小函数。

• 避免长三元表达式嵌套：把 condition ? a : (b ? c : d) 拆成 if/else 或独立判断函数
• 用早期返回（early return）减少缩进：先处理边界情况（如 !user、id ），再写主逻辑
• 对象解构代替链式访问：用 const { name, email } = user; 替代反复写 user.name、user.email

格式一致，善用空格与换行

格式本身不改变运行结果，但统一风格能让代码“呼吸感”更强，一眼定位结构。

• 运算符两侧加空格：a + b、if (count > 0)，而非 a+b 或 if(count>0)
• 对象/数组字面量换行对齐（尤其属性多时）：
    const config = {
      timeout: 5000,
      retries: 3,
      withCredentials: true
    };
• 箭头函数体单行就省略花括号和 return；多行必须加花括号并显式 return

注释务实，不解释“是什么”，说明“为什么”

好代码基本自解释，注释应补充上下文、权衡取舍或临时限制，而非复述代码。

• 避免：// 将用户名转为小写（username.toLowerCase() 已足够清楚）
• 推荐：// 兼容旧版 API，后端字段名为 'usr_name' 而非 'username'
• TODO / FIXME 注释要带责任人或截止线索，例如：// TODO(john): 替换为 useAuth hook 后移除 — 2025Q3