JavaScript代码规范

最新推荐文章于 2025-06-13 19:31:26 发布

原创最新推荐文章于 2025-06-13 19:31:26 发布 · 324 阅读

0 ·

CC 4.0 BY-SA版权

JavaScript 专栏收录该内容

24 篇文章

订阅专栏

本文介绍了JavaScript编程中的代码规范，包括变量命名、空格与运算符使用、语句及对象定义等规则，帮助开发者提高代码质量和可读性。

代码规范通常包括以下几个方面:

1.变量和函数名的命名规则
2.空格，缩进，注释的使用规则
3.其他常用规范

变量名

变量名推荐使用驼峰法（函数名中的每一个逻辑断点都有一个大写字母来标记）来命名(camelCase):

firstName = "John";
lastName = "Doe";

price = 19.90;
tax = 0.20;

fullPrice = price + (price * tax);

空格与运算符

通常使用 4 个空格符号来缩进代码块：

function toCelsius(fahrenheit) {
    return (5 / 9) * (fahrenheit - 32);
}

注意：不推荐使用 TAB 键来缩进，因为不同编辑器 TAB 键的解析不一样。

语句规则

简单语句的通用规则:一条语句通常以分号作为结束符。

var values = ["Volvo", "Saab", "Fiat"];

var person = {
    firstName: "John",
    lastName: "Doe",
    age: 50,
    eyeColor: "blue"
};

复杂语句的通用规则:
将左花括号放在第一行的结尾。
左花括号前添加一空格。
将右花括号独立放在一行。
不要以分号结束一个复杂的声明。
例子：
1.函数

function toCelsius(fahrenheit) {
    return (5 / 9) * (fahrenheit - 32);
}

2.循环

for (i = 0; i < 5; i++) {
    x += i;
}

3.条件语句

if (time < 20) {
    greeting = "Good day";
} else {
    greeting = "Good evening";
}

对象规则

对象定义的规则:
将左花括号与类名放在同一行。
冒号与属性值间有个空格。
字符串使用双引号，数字不需要。
最后一个属性-值对后面不要添加逗号。
将右花括号独立放在一行，并以分号作为结束符号

var person = {
    firstName: "John",
    lastName: "Doe",
    age: 50,
    eyeColor: "blue"
};

短的对象代码可以直接写成一行:

var person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};

每行代码字符小于80

为了便于阅读每行字符建议小于数 80 个。

如果一个 JavaScript 语句超过了 80 个字符，建议在运算符或者逗号后换行。

document.getElementById("demo").innerHTML =
    "Hello Runoob.";

命名规则

一般很多代码语言的命名规则都是类似的，例如:
变量和函数为驼峰法（ camelCase）
全局变量为大写 (UPPERCASE )
常量 (如 PI) 为大写 (UPPERCASE )
注意：
1.- 通常在 JavaScript 中被认为是减法，所以不允许使用。
2.变量名不要以 $ 作为开始标记，会与很多 JavaScript 库冲突。

HTML载入外部JavaScript文件


<script src="myscript.js">

使用 JavaScript 访问 HTML 元素

<p id="Demo">段落 1。</p>
<p id="demo">段落 2。</p>
<script>
// 只有段落 2 会被替换
document.getElementById("demo").innerHTML = "HELLO.";
</script>

文件扩展名

HTML 文件后缀可以是 .html (或r .htm)
CSS 文件后缀是 .css 。
JavaScript 文件后缀是 .js 。

使用小写文件名

大多 Web 服务器 (Apache, Unix) 对大小写敏感： london.jpg 不能通过 London.jpg 访问。

其他 Web 服务器 (Microsoft, IIS) 对大小写不敏感： london.jpg 可以通过 London.jpg 或 london.jpg 访问。

你必须保持统一的风格，我们建议统一使用小写的文件名。