JavaScript编码规范选读.doc

JavaScript编码规范 2016年02月18日  规范基本信息表： 规范简称： JavaScript编码规范 规范版本号： 1.0 规范修订日期： 2016-02-18 本规范位置： 先前版本位置： 规范制定组织： 规范制定牵头人： 王军锋 规范校订人： JavaScript编码规范 概要 规范摘要 本规范主要目的是定义基于JavaScript编码的总体规范，确保编码的规范性，提高程序的可维护性。通过遵循共同的编码规范，程序开发人员可以保持代码一贯的风格，提高代码编写的可读性和使用的一贯性。 背景 现状 相关工作说明 规范声明 适用范围 引言 词汇表 首选术语 相关术语 格式约定 文件引用 《ECMAScript-262标准》。 《JavaScript权威指南V5》。 《JavaScript高级程序设计V2》。 《JavaScript高性能》。 《Google JavaScript开发规范》。 需求 规范正文 排版规范 文件结构 JavaScript文件按如下顺序组织各元素： 序号 元素 说明 1 版权、版本声明 以注释的方式进行声明 2 总体注释 在注释中总体介绍该文件实现的功能； 对如何使用这些功能给出指导性意见； 给出使用示例； 指出注意事项； 罗列依赖的其它JavaScript文件； 注明：第一作者、第二作者…。 3 程序内容 缩进排版 以4个空格为一个缩进单元，避免使用Tab制表符。 【示例】： function getUser(id) { if ( !id ) { throw new Error(“”); } } 行排版 一行的字符不建议超过120个字符，一行过多的字符会影响查看程序的效率。 如果一段描述不能放在一行中，依据下列规则将其拆分成多行： 从分隔符（比如空格）后换行; 在运算符之前换行; 不拆分完整的单词； 换行后如果需要缩进则不应缩进超过行中。 【示例】： if ((condition1 condition2) || (condition3 condition4) ||!(condition5 condition6)) { } 空白的使用 函数之间空1行，get/set方法除外。 【示例】： function createUser() { } function destoryUser() { } function getUser() { return this.user; } function setUser(user) { this.user = user; } 代码逻辑段之间空一行。 【示例】： function getUser(id) { //判断参数id的合法性 if ( !id ) { throw new Error(“”); } //根据参数id查找user对象 findUser(id); } 语句 表达式语句 表达式语句以分号结束。 示例： ”提示信息”); Math.cos(x); 复合语句 复合语句是包含在花括号中的一个语句或者语句块，复合语句遵循如下排版规则： 左花括号”{” 位于复合语句起始行的行尾, 右大括号}应另起一行并与复合语句首行对齐； 花括号中的语句缩进一个层次（4个空格）。返回语句 【示例： if-else语句 if-else语句总是用{和}括起来,避免发生错误。 【示例： if () { statement1; } else if ( expression2 ) { statement2; } else { statement3; } for语句 【示例： for (initializ; test; increment) { statement; } 一个空的for语句：在初始化，条件判断，更新子句中完成，应该具有如下格式： 【示例： for (initializ; test; increment); for-in语句 【示例： for () { statement; } while语句 【示例： while () { statement; } do-while语句 【示例： do { statement; } while (); switch语句 【示例： switch () { case value1: statement; break; case value2: statement; break; default: statement; break; } 当一个执行完一个case后需要顺着往下执行（即没有break语句）时，通常应在break语句的位置添加注释。上面的示例代码中就包含注释/* */。 try-catch-finall