JavaScript编程代码规范草稿要点.pdf

这是一篇JavaScript 编程代码规范，它由Sun 公司的文档Code Conventionsfor theJavaProgramming Language 激发而来。 由于JavaScript isnot Java，这篇规范和Java 规范相比有很大改动。 代码质量在软件质量中占很大比例。在软件生命周期里，一个程序会 被许多人接手。如果一个程序可以很好的表达自己的结构和特性，则 在 不久的将来修改它时就会减少程序崩溃的可能。 代码规范可以帮助减少程序的脆弱性。 我们所有的JavaScript 代码都直接发布给公众，它应该具有发布质量。 Neatnesscounts. 目录: JavaScript 文件 缩进 行宽 注释 变量声明 方法声明 命名 语句 - 简单语句 - 复合语句 - 标签 -return 语句 -if语句 -for 语句 -while 语句 -do 语句 - switch 语句 -try 语句 -continue 语句 -with 语句 空格 额外的建议 - {}和[] - 逗号操作符 - 块作用域 - 赋值表达式 - 和! 操作符 - 令人混淆的加和减 - 邪恶的eval JavaScript 文件 JavaScript 程序应该作为一个.js文件存储和发布。 JavaScript 代码不应该嵌入在HTML 文件里，除非那些代码是一个单 独的会话特有的。HTML 里的JavaScript代码大大增加了页面的大小， 并且 很难通过缓存和压缩来缓解。 script src filename.js标签应该在body 里越靠后的位置越好。这减 少了由于加载script 而导致的其它页面组件的延迟。没有必要使用 language 或者type 属性。由服务器而不是script 标签来决定MIME 类 型。 缩进 缩进的最小单位是4 个空格。不要使用tab 键，because (asofthis writing in the21st Century)there still isnot a standard fortheplacement oftabstops. 使用空格会引起文件变大，但是这点大 小对局域网无关紧要，而且差别被minification 消除了。 行宽 不要让一行代码超过80个字符。当一条语句不能在单独一行写完时， 可能有必要拆分它。在操作符后进行拆分，最好是在逗号后面拆分。 操作符后面进行拆分减少了通过插入分号伪装copy-paste错误的可能 性。下一行应该缩进8个空格。 注释 慷慨的写注释。留下一些供需要理解你做了什么的人们(可能是你自 己)下次阅读的信息是有用的。注释应该书写良好和清晰，就像它们 标注的代码一样。偶尔小幽默一把也是可以的。挫折和怨恨就别写了。 更新注释非常重要。错误的注释让程序更难读懂和理解。 让注释有意义。更多的关注于不能马上可见的东西。不要用如下内容 浪费读者的时间: i 0;// Set itozero. 一般使用行注释。把块注释用于正式文档或外部注释。 变量声明 所有的变量应该在使用前声明。JavaScript 不强求这点，但是这样做 会让程序更易读，并且会让探测未声明的可能变成隐式的globals 的 变量更容易。 var 语句应该为方法体内的第一个语句。 每个变量声明应该自己占一行并有注释。它们应该按字母顺序排列。 var currentEntry;// currentyly selectedtable entry var level;// indentation level var size;// size oftable JavaScript 没有块作用域，所以在块里定义变量可能会让有其它C 家 族语言经验的程序员迷惑。在方法顶端定义所有变量。 尽量少使用全局变量。隐式的全局变量应该从来不使用。 方法声明 所有的方法应该在它们使用前声明。内部方法应该位于var语句后面。 这让哪些变量包含在它的scope 里更清楚。 方法名和参数列表的“(”(左圆括号)之间不应该有空格。在“)”(右圆括 号)和“{”(左大括号)之间有一个空格。 方法体本身缩进4 个空格。“}”(右大括号)应该和方法声明处对齐。 function outer(c,d) { var e c *d; function inner(a,b) { return (e *a)+b; } return inner(0, 1); } 这个规范可以和JavaScript 很好的工作，