该文部分代码和内容节选自菜鸟教程,仅用作个人学习,特此声明
链接:https://www.runoob.com/
代码规范通常包括以下几个方面:
- 变量和函数的命名规则
- 空格,缩进,注释的使用规则。
- 其他常用规范……
变量名:推荐使用驼峰法来命名
举例
firstName = "John"; lastName = "Doe"; price = 19.90; tax = 0.20; fullPrice = price + (price * tax);
运算符:通常运算符 ( = + - * / ) 前后需要添加空格
举例
var x = y + z; var values = ["Volvo", "Saab", "Fiat"];
代码缩进:通常使用 4 个空格符号来缩进代码块
需要注意的是:不推荐使用 TAB 键来缩进,因为不同编辑器 TAB 键的解析不一样
举例
function toCelsius(fahrenheit) { return (5 / 9) * (fahrenheit - 32); }
语句规则:
简单语句的通用规则
复杂语句的通用规则
举例:
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
document.getElementById("demo").innerHTML = "Hello Runoob.";
一般很多代码语言的命名规则都是类似的,例如:
变量和函数为小驼峰法标识, 即除第一个单词之外,其他单词首字母大写( lowerCamelCase)
全局变量为大写 (UPPERCASE )
常量 (如 PI) 为大写 (UPPERCASE )
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 文件后缀可以是 .html (或 .htm)
CSS 文件后缀是 .css
JavaScript 文件后缀是 .js
尽量使用小写的文件名