JavaScript编程代码标准草稿.doc

《JavaScript编程代码标准草稿.doc》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、这是一篇JavaScript编程代码规范，它由Sun公司的文档CodeConventionsfortheJavaProgrammingLanguage激发而来。由于JavaScriptisnotJava,这篇规范和Java规范相比有很大改动。代码质量在软件质量中占很大比例。在软件生命周期里，一个程序会被许多人接手。如果一个程序可以很好的表达自己的结构和特性，则在不久的将来修改它时就会减少程序崩溃的可能。代码规范可以帮助减少程序的脆弱性。我们所有的JavaScript代码都直接发布给公众，它应该具有发布质量。Neatnesscounts.目录：Jav

2、aScript文件缩进行宽注释变量声明方法声明命名语句-简单语句-复合语句-标签-return语句-if语句-for语句-while语句-do语句-switch语句-try语句-continue语句-with语句空格额外的建议-{}和[]-逗号操作符-块作用域-赋值表达式一==和!==操作符・令人混淆的加和减-邪恶的evalJavaScript文件JavaScript程序应该作为一个.js文件存储和发布。JavaScript代码不应该嵌入在HTML文件里，除非那些代码是一个单独的会话特有的。HTML里的JavaScript代码大大增加了页面的大小,

3、并且很难通过缓存和压缩来缓解。标签应该在body里越靠后的位置越好。这减少了由于加载script而导致的其它页面组件的延迟。没有必要使用language或者type属性。由服务器而不是script标签来决定MIME类型。缩进缩进的最小单位是4个空格。不要使用tab键，because(asofthiswritinginthe21stCentury）therestillisnotastandardfortheplacementoftabstops.使用空格会引起文件变大，但是这点大小对局域网无关紧要，而且差

4、别被minification消除了。行宽不要让一行代码超过80个字符。当一条语句不能在单独-•行写完时,可能有必要拆分它。在操作符后进行拆分，最好是在逗号后面拆分。操作符后面进行拆分减少了通过插入分号伪装copy-paste错误的可能性。下一行应该缩进8个空格。注释慷慨的写注释。留下一些供需要理解你做了什么的人们（可能是你自己）下次阅读的信息是有用的。注释应该书写良好和清晰，就像它们标注的代码一样。偶尔小幽默一把也是可以的。挫折和怨恨就别写了。更新注释非常重要。错误的注释让程序更难读懂和理解。让注释有意义。更多的关注于不能马上可见的东西。不要用如下

5、内容浪费读者的时间：i=0;//Setitozero.一般使用行注释。把块注释用于正式文档或外部注释。变量声明所有的变量应该在使用前声明。JavaScript不强求这点，但是这样做会让程序更易读，并旦会让探测未声明的可能变成隐式的globals的变量更容易。var•语句应该为方法体内的第一个语句。每个变量声明应该自己占一行并有注释。它们应该按字母顺序排列。varcurrentEntry;//currentylyselectedtableentryvarlevel;//indentationlevelvarsize;//sizeoftableJava

6、Script没有块作用域，所以在块里定义变量可能会让有其它C家族语言经验的程序员迷惑。在方法顶端定义所有变量。尽量少使用全局变量。隐式的全局变量应该从来不使用。方法声明所有的方法应该在它们使用前声明。内部方法应该位于var语句后面。这让哪些变量包含在它的scope里更清楚。方法名和参数列表的飞”(左圆括号)之间不应该有空格。在“)”(右圆括号)和V(左大括号)之间有一个空格。方法体本身缩进4个空格。“广(右大括号)应该和方法声明处对齐。functionouter(c,d)(vare=c*d;functioninner(a,b)(return(e*a

7、)+b;returninner(0,1);}这个规范可以和JavaScript很好的工作，因为在JavaScript里方法和对象字面量可以放在允许表达式的任何位置。它使用内部方法和复杂结构提供最好的可读性。functiongetElementsByClassName(className)(varresults=[J;walkTheDOM(document.body,function(node){vara;//arrayofclassnamesvarc=node.className;//thenode'sclassnamevari;//loopcou

8、nter//Ifthenodehasaclassname,thensplititintoalistofsimplename