首页 > 网站 > WEB开发 > 正文

javascript编程规范(持续更新中...)

2024-04-27 14:19:36
字体:
来源:转载
供稿:网友

javascript编程规范(持续更新中...)

缩进

每个层级由4个空格组成,避免使用Tab

行的长度

每行长度不超过80个字符,如果一行多于80个字符,应当在一个运算符(逗号,加号等)后换行。下一行应当增加两级缩进(8个字符)。

原始值

字符串始终使用双引号(避免使用单引号)且保持一行。避免在字符串中使用斜线另起一行。

数字应当使用十进制整数。科学计数法表示整数,十六进制整数,或者十进制浮点小数,小数点前后应当至少保留一位数字。避免使用八进制直接量。

特殊值null除了下述情况下应当避免使用。

a) 用来初始化一个标量,这个变量可能被赋值为一个对象。

b) 用来和一个已经初始化的变量比较,这个变量可以是也可以不是一个对象。

c) 当函数的参数期望是对象时,被用作参数传入。

d) 当函数的返回值期望是对象时,被用作返回值传出。

避免使用特殊值undefined。判断一个变量是否定义应当使用typeof操作符。

运算符间距

二元运算符前后必须使用一个空格来保持表达式的整洁。操作符包括赋值运算符和逻辑运算符。

括号间距

当使用括号时,紧接左括号之后和紧接右括号之前不应该有空格。

对象直接量应当使用如下格式

a) 起始左花括号应当同表达式保持同一行。

b) 每个属性的名值对(key-value)应当保持一个缩进,第一个属性应当在左花括号后另起一行。

c) 每个属性的名值对(key-value)应当使用不含引号的属性名,其后紧跟一个冒号(之前不含空格),而后是值。

d) 倘若属性值是函数类型,函数体应当在属性名之下另起一行,而且其前后均应保留一个空行。

e) 一组相关的属性前后可以插入空行以提升代码的可读性。

f) 结束的右花括号应当独占一行。

g) 当对象字面量作为函数参数时,如果值是变量,起始花括号应当同函数名在同一行。所有其余先前列出的规则同样适用。

注释

频繁地适用注释有助于他人理解的你的代码。如下情况应当使用注释。

a) 代码晦涩难懂。

b) 可能被误认为错误的代码。

c) 必要但并不明显的针对特定浏览器的代码。

d) 对于对象、方法或者属性,生成文档时有必要的(使用恰当的文档注释)。

单行注释

单行注释应当用来说明一行代码或者一组相关的代码。单行注释可能有三种使用方式。

a) 独占一行的注释,用来解释下一行代码。

b) 在代码行尾部的注释,用来解释它之前的代码。

c) 多行,用来注释掉一个代码块。

对于代码行尾单行注释的情况,应确保代码结尾同注释之间至少一个缩进。

注释一个代码块是连续多行使用单行注释是唯一可以接受的情况。多行注释不应当在这种情况下使用。


发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表