当前位置:首页 > Javascript编程 > Javascript基础

JavaScript 代码规范

javascript 代码规范

所有的 javascript 项目适用同一种规范。

javascript 代码规范

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

  • 变量和函数的命名规则
  • 空格,缩进,注释的使用规则。
  • 其他常用规范……

规范的代码可以更易于阅读与维护。

代码规范一般在开发前规定,可以跟你的团队成员来协商设置。

变量名

变量名推荐使用驼峰法来命名(camelcase):

firstname = "john";
lastname = "doe";

price = 19.90;
tax = 0.20;

fullprice = price + (price * tax);

空格与运算符

通常运算符 ( = + - * / ) 前后需要添加空格:

实例:
var x = y + z;
var values = ["volvo", "saab", "fiat"];

代码缩进

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

函数:
function tocelsius(fahrenheit) {
    return (5 / 9) * (fahrenheit - 32);
}
note 不推荐使用 tab 键来缩进,因为不同编辑器 tab 键的解析不一样。

语句规则

简单语句的通用规则:

  • 一条语句通常以分号作为结束符。
实例:
var values = ["volvo", "saab", "fiat"];

var person = {
    firstname: "john",
    lastname: "doe",
    age: 50,
    eyecolor: "blue"
};

复杂语句的通用规则:

  • 将左花括号放在第一行的结尾。
  • 左花括号前添加一空格。
  • 将右花括号独立放在一行。
  • 不要以分号结束一个复杂的声明。
函数:
function tocelsius(fahrenheit) {
    return (5 / 9) * (fahrenheit - 32);
}

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

条件语句:
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.";


命名规则

一般很多代码语言的命名规则都是类似的,例如:

  • 变量和函数为小驼峰法标识, 即除第一个单词之外,其他单词首字母大写( lowercamelcase)
  • 全局变量为大写 (uppercase )
  • 常量 (如 pi) 为大写 (uppercase )

变量命名你是否使用这几种规则: hyp-hens, camelcase, 或under_scores ?

html 和 css 的横杠(-)字符:

html5 属性可以以 data- (如:data-quantity, data-price) 作为前缀。

css 使用 - 来连接属性名 (font-size)。

- 通常在 javascript 中被认为是减法,所以不允许使用。

下划线:

很多程序员比较喜欢使用下划线(如:date_of_birth), 特别是在 sql 数据库中。

php 语言通常都使用下划线。

帕斯卡拼写法(pascalcase):

帕斯卡拼写法(pascalcase) 在 c 语言中语言较多。

驼峰法:

javascript 中通常推荐使用驼峰法,jquery 及其他 javascript 库都使用驼峰法。

变量名不要以 $ 作为开始标记,会与很多 javascript 库冲突。

html 载入外部 javascript 文件

使用简洁的格式载入 javascript 文件 ( type 属性不是必须的):

<script src="myscript.js">

使用 javascript 访问 html 元素

一个糟糕的 html 格式可能会导致 javascript 执行错误。

以下两个 javascript 语句会输出不同结果:

实例
var obj = getelementbyid("demo")

var obj = getelementbyid("demo")


html 与 javascript 尽量使用相同的命名规则。

访问 html(5) 代码规范

文件扩展名

html 文件后缀可以是 .html (或 .htm)。

css 文件后缀是 .css 。

javascript 文件后缀是 .js 。

使用小写文件名

大多 web 服务器 (apache, unix) 对大小写敏感: london.jpg 不能通过 london.jpg 访问。

其他 web 服务器 (microsoft, iis) 对大小写不敏感: london.jpg 可以通过 london.jpg 或 london.jpg 访问。

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


【说明】本文章由站长整理发布,文章内容不代表本站观点,如文中有侵权行为,请与本站客服联系(QQ:254677821)!