javascript代码规范

《javascript代码规范》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、javascript代码规范[键入文档副标题]李博[选取日期]1.14目录1.JS文件基本规范21.1.JavaScript文件21.2.版权和版本的声明21.3.编码格式22.程序的版式32.1.空格32.2.缩进32.3.行宽42.4.注释42.5.变量声明52.6.方法声明62.7.命名规则83.语句的规范83.1.简单语句83.2.复杂语句83.3.语句实例93.3.1.return语句93.3.2.if语句93.3.3.for语句93.3.4.while语句103.3.5.do语句103.3.6.sw

2、itch语句113.3.7.try语句113.3.8.continue语句123.3.9.with语句123.4.额外建议123.4.1.{}和[]12143.4.2.逗号操作符123.4.3.块作用域123.4.4.赋值表达式123.4.5.===和!==操作符123.4.6.令人混淆的加和减133.4.7.邪恶的eval1314JS文件基本规范1.1.JavaScript文件JavaScript程序应该作为一个单独的.js文件存储和发布。JavaScript代码不应该嵌入在HTML文件里，除非那些代码是一个

3、单独的会话特有的。HTML里的JavaScript代码大大增加了页面的大小，并且很难通过缓存和压缩来缓解。标签应该在body里越靠后的位置越好。这减少了由于加载script而导致的其它页面组件的延迟。没有必要使用language或者type属性。由服务器而不是script标签来决定MIME类型。1.2.版权和版本的声明版权和版本的声明位于文件的开头，以注释的结构出现，如图表11所示：/**可视化网页编辑器***摘要：简要叙述本文件内容以及功能**当前版本：1.

4、1*作者：输入作者（或修改者）名字*完成日期：**年*月*日**取代版本：1.0*原作者：输入原作者（或修改者）名字*完成日期：**年*月*日*/图表11版权和版本声明1.3.编码格式14所有js文件（以及其他html、css等文件），均使用utf-8编码1.程序的版式1.1.空格空行通过将逻辑相关的代码放到一起来增加可读性。空格应该用于如下情况:1.关键字后面跟“(”(左圆括号)时应该用一个空格隔开。代码while (true) {  2.方法名和方法的“(”(左圆括号)之间不要有空格。这利于区分关键字和方

5、法调用。3.所有的二元操作符，除了“.”(圆点)、“(”(左圆括号)和“[”(左中括号)，都应该使用一个空格来和操作数隔开。4.一元操作符和操作数之间不应该使用空格隔开，除了操作符是一个单词时，如typeof。5.for语句控制部分的每个“;”(分号)应该在后面跟一个空格。6.每个“,”(逗号)后面应该跟一个空格。1.2.缩进缩进的最小单位是4个空格,4个空格为一个缩进单位。不要使用tab键,一个函数的开始顶格写,进入函数体之后缩进一个单位,进入下一层再缩进一个单位,以此类推,例子如下:FunctiongetA

6、ttr(){For(varI=0;I

7、串之后对该标签进行计息参数str表示…*/(2)对于新定义变量的用途以及关键的语句必须进行单行注释，注释添加的位置可以在上一行，也可以在行末，视情况而定，如果一个语句较长，推荐在上一行进行注释；如果语句较短可以在行末进行注释。（3）对于一个函数的结尾，应该在结尾处加上此函数结束的标志用于表示函数的结束，例如：//endoffunctiongetAtrr（4）对于有多层嵌套，应该在最外层以及具有关键意义的层的结尾处添加结束注释，例如：For(varI=…){Varj=0;…14If(…){For(vart…){…

8、}}//endofif}//endoffor更新注释非常重要,修改后的代码应该及时的更新注释，函数功能转变了应该及时的更新函数头的注释。（5）让注释有意义。更多的关注于不能马上可见的东西。不要用如下内容浪费读者的时间:代码i = 0; // Set i to zero.  一般使用行注释。把块注释用于正式文档或外部注释。1.1.变量声明（1）所有的变量应该在使用前声明，并添加用途注释。