Javascript代码细则.doc

javascript代码规范 李博 [选取日期] 目录 1.JS文件基本规范 2 1.1. JavaScript文件 2 1.2. 版权和版本的声明 2 1.3. 编码格式 2 2. 程序的版式 3 2.1. 空格 3 2.2. 缩进 3 2.3. 行宽 4 2.4. 注释 4 2.5. 变量声明 5 2.6. 方法声明 6 2.7. 命名规则 8 3. 语句的规范 8 3.1. 简单语句 8 3.2. 复杂语句 8 3.3. 语句实例 9 3.3.1. return语句 9 3.3.2. if语句 9 3.3.3. for语句 9 3.3.4. while语句 10 3.3.5. do语句 10 3.3.6. switch语句 11 3.3.7. try语句 11 3.3.8. continue语句 12 3.3.9. with语句 12 3.4. 额外建议 12 3.4.1. {}和[] 12 3.4.2. 逗号操作符 12 3.4.3. 块作用域 12 3.4.4. 赋值表达式 12 3.4.5. ===和!==操作符 12 3.4.6. 令人混淆的加和减 13 3.4.7. 邪恶的eval 13 JS文件基本规范 JavaScript文件 JavaScript程序应该作为一个.js文件存储和发布。JavaScript代码不应该嵌入在HTML文件里，除非那些代码是一个单独的会话特有的。HTML里的JavaScript代码大大增加了页面的大小，并且很难通过缓存和压缩来缓解。script src=”filename.js”标签应该在body里越靠后的位置越好。这减少了由于加载script而导致的其它页面组件的延迟。没有必要使用language或者type属性。由服务器而不是script标签来决定MIME类型。图表 11 编码格式 所有js文件（以及其他html、css等文件），均使用utf-8编码 程序的版式 空格空行通过将逻辑相关的代码放到一起来增加可读性。 空格应该用于如下情况: 关键字后面跟“(”(左圆括号)时应该用一个空格隔开。 代码 while?(true)?{ ?? 方法名和方法的“(”(左圆括号)之间不要有空格。这利于区分关键字和方法调用。所有的二元操作符，除了“.”(圆点)、“(”(左圆括号)和“[”(左中括号)，都应该使用一个空格来和操作数隔开。一元操作符和操作数之间不应该使用空格隔开，除了操作符是一个单词时，如typeof。for语句控制部分的每个“;”(分号)应该在后面跟一个空格。每个“,”(逗号)后面应该跟一个空格。 缩进 缩进的最小单位是4个空格。不要使用tab键Function getAttr() { For(var I = 0; I n; i++) { Alert(“hello”); } } 所有的“{”和“}”必须缩进的距离都一样，不能出现左括号缩进2个字符，右括号缩进4个字符这样缩进不等的情况。 行宽 不要让一行代码超过80个字符。当一条语句不能在单独一行写完时，可能有必要拆分它。在操作符后进行拆分，最好是在逗号后面拆分。操作符后面进行拆分减少了通过插入分号伪装copy-paste错误的可能性。下一行应该缩进8个空格。 注释/* 此函数用于在获取标签字符串之后对该标签进行计息 参数str表示… */ (2) 对于新定义变量的用途以及关键的语句必须进行单行注释，注释添加的位置可以在上一行，也可以在行末，视情况而定，如果一个语句较长，推荐在上一行进行注释；如果语句较短可以在行末进行注释。 （3）对于一个函数的结尾，应该在结尾处加上此函数结束的标志用于表示函数的结束，例如： // end of function getAtrr （4）对于有多层嵌套，应该在最外层以及具有关键意义的层的结尾处添加结束注释，例如： For(var I = …) { Var j = 0; … If(…) { For(var t…) { … } } // end of if }// end of for 更新注释非常重要 （5）让注释有意义。更多的关注于不能马上可见的东西。不要用如下内容浪费读者的时间: 代码 i?=?0;?//?Set?i?to?zero. ?? 一般使用行注释。把块注释用于正式文档或外部注释。 变量声明 所有的变量应该在使用前声明。 var语句为方法体内的第一个语句 代码 var?currentEntry;?//?currentyly?selected?table?entry ?? var?level;????????//?indentation?level ?? var?size;?????????//?size?of?table ?