JavaScript标准书写格式规范|新手从零学会优雅写JS代码
很多新手写 JavaScript 代码,最大的问题不是不会写逻辑,而是 书写混乱、格式随意:缩进乱、不加分号、变量随便命名、代码堆砌一堆。
看似代码能跑,但是可读性极差、极易出Bug、后期完全无法维护。
本篇博客总结一套新手通用、企业通用的 JS 标准书写格式,照着写就能写出干净、规范、专业的JS代码。
一、为什么要统一JS书写格式?
- 可读性高:自己和别人都能一眼看懂代码结构
- 减少隐性Bug:格式不规范是很多诡异报错的元凶
- 团队协作必备:企业开发强制统一编码风格
- 方便调试与迭代:结构清晰,改代码不翻车
二、JS 基础全局书写规范(必背)
- 缩进规范(最重要)
统一使用 2个空格 或 4个空格缩进,全程一致,禁止混用Tab
推荐新手:4个空格缩进,结构最清晰。
❌ 错误写法(缩进混乱)
function test(){
let a=1;
if(a>0){
console.log(a)
}
}
✅ 标准规范写法
function test() {
let a = 1;
if (a > 0) {
console.log(a);
}
} - 语句必须结尾分号 ;
虽然JS可以自动补全分号,但绝对不要依赖自动分号,极易出现隐秘Bug。
✅ 每条语句末尾必须加 ; - 运算符前后必须加空格
赋值、比较、加减乘除等运算符,左右必须留空,代码更舒展。
❌ 不规范:let a=1+2;
✅ 规范:let a = 1 + 2; - 大括号格式:同一行开启
企业统一风格:左大括号不换行
✅ 标准
if (flag) {
// 代码
}
❌ 不允许
if (flag)
{
}
三、变量 & 常量 书写格式规范
- 声明方式强制规范
禁止使用 var,全部使用 let / const
- 值不改变:用 const
- 值会改变:用let
- 命名规范(驼峰命名法)
JS 统一使用 小驼峰命名
- 变量、函数:小驼峰 userName
- 常量:全大写+下划线MAX_COUNT
- 禁止拼音、禁止中文、禁止随意简写
✅ 规范示例
const PAGE_SIZE = 10;
let userName = “张三”;
let userAge = 20;
❌ 不规范
let a = 10;
let name222 = “”;
let yonghuMing = “”;
四、数组、对象标准书写格式
- 数组书写规范
简单数组单行书写,复杂数组换行对齐
✅ 规范
let arr = [11, 22, 33, 44];
let list = [
{ id: 1, name: “测试1” },
{ id: 2, name: “测试2” }
];
2. 对象书写规范
key 后冒号加空格,最后一项也可以带逗号(兼容规范)
let userInfo = {
id: 1001,
username: “小明”,
age: 18
};
五、条件、循环语句书写格式
- if 标准格式
无论代码几行,必须加大括号,禁止单行省略大括号
✅ 标准
if (score >= 60) {
console.log(“及格”);
} else {
console.log(“不及格”);
}
❌ 禁止(极易出错)
if(score>60) console.log(“ok”); - for / while 规范
for (let i = 0; i < arr.length; i++) {
console.log(arr[i]);
}
while (flag) {
// 循环逻辑
}
六、函数标准书写格式
函数是JS核心,格式必须统一、整洁。
- 普通函数规范
// 函数功能简短注释
function getUserName(userId) {
return “用户” + userId;
} - 箭头函数规范
复杂函数换行,简单函数单行
// 简单写法
let add = (a, b) => a + b;
// 复杂写法换行
let filterList = (arr) => {
return arr.filter(item => item > 10);
};
七、注释书写规范
注释不是越多越好,关键逻辑必须注释,基础代码不废话注释
- 单行注释:// 注释内容(//后面加空格)
- 多行注释:用于函数、模块说明
✅ 规范示例
// 获取用户列表数据
function getUserList() {
// 模拟接口请求
return [];
}
八、完整规范 JS 代码模板(可直接复用)
这是一套企业级标准JS书写模板,新手写代码直接套这个格式:
九、新手最容易犯的格式错误汇总
- 不写分号、缩进混乱
- 乱用 var,变量不规范
- if/for 省略大括号
- 运算符前后不加空格,代码拥挤
- 所有代码堆在一起,不分模块
- 命名随便 a、b、c、temp、aaa
十、规范总结(记住这6句话)
- 全程统一缩进,代码层层对齐
- 语句必须带分号,运算符前后空格
- 常量用const,变量用let,禁止var
- 命名小驼峰,语义清晰不随意
- 判断循环必加大括号,不偷懒简写
- 代码分区:常量→变量→函数→业务逻辑
写在最后
代码的书写格式,决定了你代码的下限。
逻辑可以慢慢练,但是格式必须从第一天就写标准。养成规范的JS书写习惯,后续学习ES6、AJAX、Vue、React 都会事半功倍。