js 编写规范

下面我来详细讲解“JS 编写规范”的攻略。

规范一：命名规范

• 变量和函数名：使用小驼峰式命名法，首字母小写，如 firstName。
• 常量名：使用全大写命名法，单词之间使用下划线分割，如 MAX_NUM。
• 类名：使用帕斯卡命名法，首字母大写，如 Person。
• 私有成员：使用下划线前缀标识私有成员，如 _private.

示例代码1：

let count = 0;
const API_URL = 'https://example.com/api';
class Person {
    constructor(name, age) {
        this._name = name;
        this._age = age;
    }

    get name() {
        return this._name;
    }

    set name(value) {
        this._name = value;
    }

    sayHello() {
        console.log(`Hello, my name is ${this._name}.`);
    }
}

规范二：缩进和空格

• 缩进：使用 4 个空格作为一个缩进级别。
• 空格：在运算符和操作符两侧均需要加上空格。 {} 之间、, 后面、函数参数列表之间不需要加空格。

示例代码2：

function calculateProfit(price, quantity, cost) {
    const grossRevenue = price * quantity;
    const grossProfit = grossRevenue - cost;

    return grossProfit;
}

const person = {
    firstName: 'John',
    lastName: 'Doe',
    age: 30,
};

const sum = (a, b) => a + b;
console.log(sum(2, 3)); // 5

规范三：注释

• 单行注释：以 // 开头，注释内容在注释符号后空 1 个空格，如 // 单行注释。
• 多行注释：以 /*...*/ 包裹，注释符号下一行空一行，如

/*
 * 多行注释1
 * 多行注释2
 */

• 函数注释：使用 JSDoc 注释规范，注释内容包括函数功能、参数列表、返回值和异常列表。

示例代码3：

/**
 * 计算两个数的和
 * @param {number} a - 第一个加数
 * @param {number} b - 第二个加数
 * @returns {number} 返回两个数的和
 */
function sum(a, b) {
    return a + b;
}

/**
 * Person 类
 * @class
 */
class Person {
    /**
     * 创建一个人
     * @param {string} name - 姓名
     * @param {number} age - 年龄
     */
    constructor(name, age) {
        this.name = name;
        this.age = age;
    }

    /**
     * 说 hello
     */
    sayHello() {
        console.log(`Hello, my name is ${this.name}.`);
    }
}

以上就是“JS 编写规范”的详细攻略。希望能对您有所帮助！