你是不是刚开始学 JavaScript?有没有遇到这样的问题:

  • 写的代码看起来乱七八糟?
  • 看不懂别人写的代码?
  • 为什么别人写出来的代码那么“整齐”?

其实,写代码也是有“规矩”的!这些规矩叫做 书写规范,它们就像写作文的格式一样,能让你的代码看起来更专业、更清晰。


一、变量怎么命名才规范?

变量名就像是你给东西起的名字,要让人一看就懂。

  • 变量名:用小驼峰法(首字母小写,后面的单词首字母大写)

    let userName = "小明";
    let age = 20;
  • 常量名:全大写,用下划线分隔

    const PI = 3.14159;
    const MAX_ATTEMPTS = 5;

二、代码排版要整洁

写代码也要像写作业一样,排版整齐,别乱来。

  • 缩进:每段代码前空两格(用空格,不是 Tab)
  • 每行不要太长:控制在 80 个字符以内,太长了就换行
  • 括号对齐:括号和代码写在同一行,别换行
    if (age >= 18) {
        console.log("你可以投票");
    }

三、函数怎么写才规范?

函数就是你写的一段“可以重复用的代码”。

  • 函数名:也用小驼峰

    function sayHello() {
        console.log("你好");
    }
  • 参数别太多:最好不超过 3 个,否则容易搞混

  • 一个函数只干一件事:别写太复杂的函数,不然你自己都看不懂


四、加上注释更容易理解

注释就是你写在代码旁边的“说明”,别人一看就知道这段代码是干嘛的。

  • 单行注释:用 // 开头

    // 这是打招呼的函数
    function sayHello() {
        console.log("你好");
    }
  • 多行注释:用 /* ... */

    /*
     * 这是一个计算价格的函数
     * 参数是单价和数量
     */
    function calculatePrice(price, quantity) {
        return price * quantity;
    }

五、推荐使用工具帮你检查规范

你不需要自己记住所有规范,可以借助一些工具:

  • ESLint:自动检查代码是否符合规范
  • Prettier:一键帮你格式化代码,让它看起来更整齐

六、给新手的建议

  1. 先写好变量名和函数名,别用 a、b、c 这种名字。
  2. 写代码时注意缩进和换行,别写成一坨。
  3. 多看别人写的代码,学习他们的风格。
  4. 用工具检查你的代码规范,养成好习惯。
  5. 多动手练习,写小项目,比如做一个计算器、待办事项列表。

总结一下

JavaScript 的书写规范主要包括:

规范内容 新手建议
变量命名 小驼峰,见名知意
函数命名 小驼峰,一个函数只干一件事
缩进 用空格,每段代码缩进两格
注释 多写注释,方便理解
工具 用 ESLint 或 Prettier 自动格式化

写代码就像写作文,格式规范了,别人才能看懂你写的什么。坚持写规范代码,你也能写出“专业级”的 JavaScript!

Logo

Agent 垂直技术社区,欢迎活跃、内容共建。

更多推荐