登录
首页 >  文章 >  前端

JavaScript代码规范与风格详解

时间:2026-03-08 23:18:32 253浏览 收藏

编写JavaScript代码的核心目标不仅是让程序正确运行,更是让人轻松理解与维护;本文系统梳理了提升代码质量的关键实践——从camelCase变量命名、UPPER_CASE常量定义到优先使用const、统一4空格缩进与1TBS大括号风格,再到函数单一职责、参数精简、模块接口清晰、错误兜底处理及“解释原因而非描述动作”的高价值注释,并强调通过ESLint与Prettier工具化落地规范,真正实现团队协作高效、代码长期可演进。

JavaScript代码风格_javascript规范指南

写JavaScript代码不只是让机器能执行,更重要的是让人能看懂。良好的代码风格能提升可读性、降低维护成本、减少错误。以下是一些实用的规范建议,适合团队协作和个人项目。

变量与命名

变量名要清晰表达用途,避免缩写或无意义的字符。

  • 使用camelCase命名变量和函数,如userNamegetUserInfo
  • 常量用UPPER_CASE,多个词用下划线分隔,如MAX_RETRY_COUNT
  • 布尔类型可加ishasshould前缀,如isLoadinghasPermission
  • 避免使用letvar,优先用const声明不变的值

代码结构与格式

统一的格式让代码看起来整洁一致。

  • 使用4个空格缩进(或2个,根据团队约定),不要用Tab
  • 每行代码不超过80~100个字符,过长应换行
  • 大括号放在同一行,遵循1TBS风格
  • 控制语句(if、for、while)必须带大括号,即使只有一行
  • 函数定义后留一个空行,不同逻辑块之间用空行分隔

示例:

function calculateTotal(items) {
    const taxRate = 0.08;
    let total = 0;
<pre class="brush:php;toolbar:false"><code>for (let i = 0; i &lt; items.length; i++) {
    total += items[i].price;
}

return total * (1 + taxRate);</code>

}

函数与模块设计

函数应该专注单一任务,易于测试和复用。

  • 函数长度尽量控制在20行以内
  • 参数不超过3个,过多时考虑传入对象
  • 优先使用箭头函数处理简单回调,但保持一致性
  • 模块导出清晰的接口,避免暴露内部实现

推荐:

const formatPrice = (amount, currency = 'CNY') => {
    return new Intl.NumberFormat('zh-CN', { style: 'currency', currency }).format(amount);
};

错误处理与注释

健壮的代码需要考虑异常情况,注释应解释“为什么”而不是“做什么”。

  • 异步操作必须处理reject,使用try/catch或.catch()
  • 自定义错误要有明确信息,方便调试
  • 注释重点说明复杂逻辑、业务规则或临时方案
  • 避免过时或冗余注释,比如// 循环开始这类无意义内容

基本上就这些。坚持使用ESLint配合Prettier,能自动帮你维持风格统一。关键是团队达成一致,并通过工具落实,而不是靠人盯人。

以上就是《JavaScript代码规范与风格详解》的详细内容,更多关于的资料请关注golang学习网公众号!

资料下载
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>