JavaScript的代码编写格式规范指南
对于熟悉C/C++或Java语言的工程师来说，JavaScript显得灵活，简单易懂，对代码的格式的要求也相对松散。很容易学习，并运用到自己的代码中。也正因为这样，JavaScript的编码规范也往往被轻视，开发过程中修修补补，最终也就演变成为后续维护人员的恶梦。软件存在的长期价值直接与编码的质量成比例。编码规范能帮助我们降低编程中不必要的麻烦。而JavaScript代码是直接发送给客户浏览器的，直接与客户见面，编码的质量更应该受到关注。
本文浅谈JavaScript编程中关于编码规范的问题，分析其中缘由。希望引起更多Web开发人员对JavaScript编码规范问题的关注和对软件产品质量问题的重视。
前言
提及C/C++和Java编码规范，相信许多工程师并不生疏。但说到JavaScript语言的编码规范，也许您会忍俊不禁。JavaScript不是语法很灵活吗？变量随时用随时可以声明；语句结束符可以不要；字符串和数字也可以相加；参数多一个少一个也不会报错。没错，当您从C/C++和Java严格的语法规定之下，转向JavaScript语言，会觉得自由了很多，轻松了很多。语法松散是JavaScript重要的特征。它灵活易懂，给开发人员带来了很多方便，但如果编写过程中不注意，代码的调试成本和维护成本则会无形地增加。
JavaScript编码会随应被直接发送到客户端的浏览器，代码规范不只是代码质量的保证，也影响到产品的长期信誉。希望JavaScript编程语言的规范问题也能同样引起更多朋友的关注。
JavaScript编码规范建议
本文就JavaScript编码过程中涉及的排版、命名、声明、作用域、及一些特殊符号的使用等方面，根据个人在学习工作中的总结，给出自己的一些建议，并分析其中缘由，以供参考。
JavaScript文件引用
JavaScript程序应该尽量放在.js的文件中，需要调用的时候在HTML中以<scriptsrc="filename.js">的形式包含进来。JavaScript代码若不是该HTML文件所专用的，则应尽量避免在HTML文件中直接编写JavaScript代码。因为这样会大大增加HTML文件的大小，无益于代码的压缩和缓存的使用。
另外，<scriptsrc="filename.js">标签应尽量放在文件的后面。这样会降低因加载JavaScript代码而影响页面中其它组件的加载时间。
代码排版
行长度
每行代码应小于80个字符。如果代码较长，应尽量选择换行，下一行代码应缩进8个空格。这样可以使代码排版整齐，减轻阅读代码的疲劳感。换行缩进8个空格可以和代码段的缩进4个空格区分开，以增强代码的可阅读性。
行结束
JavaScript语句应该以分号结束。但大多数浏览器允许不写分号，只要在本应是分号的地方有一个换行符就行。但是如果代码行较长需要换行的时候，有哪些注意事项呢？换行应选择在操作符和标点符号之后，最好是在逗号','之后，而不要在变量名、字符串、数字、或')'']''++''--'等符号之后换行。
这样可以有效的防止拷贝、粘贴而引起的错误，并可有效地增强代码的可阅读性。请见清单1，代码的输出符合我们的期望。但就写法而言，对valueB的赋值语句是在变量valueA之后进行的换行，这很容易被误解为valueB=ValueA，给阅读造成障碍。而对valueC的复制语句是在'+'之后进行的换行，就容易理解的多。这也是本文所提倡的换行方式。
清单1.行结束的位置
<scriptlanguage="javascript"> varvalueA=1; varvalueB=valueA///bad +1; varvalueC=valueB+///good valueA; alert(valueB);//output:valueB=2 alert(valueC);//output:valueC=3 </script>
缩进
关于缩进的问题，不只是JavaScript，几乎所有的语言编写的时候，都会提及缩进的问题。缩进几乎是代码编写规范的第一课，是代码可阅读性判断的直接因素。
代码缩进的好处是不言而喻的，但是对于如何缩进，则没有标准而言。最受欢迎的是方便使用TAB键缩进，也有些喜欢用2个、4个、8个空格进行缩进。这样缩进风格不一，也同样给代码的阅读带来障碍。
本文提倡用4个空格来进行缩进，并在同一产品中采用同一种缩进标准。不支持用TAB键进行缩进。这是因为直到现在还没有统一的标准来定义TAB键所代替的空白大小，有些编辑器解析为4个空格大小，有些则解析为8个。因而用不同的编辑器查看代码，可能造成格式混乱。当然TAB简单易用，为解决这个问题，建议在设置开发环境时，将编辑器里的TAB快捷键重新设置为4个空格。据了解Eclipse,Vi,Nodepad++，Editplus,UltraEdit等流行的编辑器，均提供了此功能。
注释
代码中的注释很重要，自然也是毋庸置疑的。通常我们会强调代码中注释数量的多少，而轻视了对注释质量的提高。编码是及时添加注释，会给后续代码的维护人员带来很大的便利。但是如果注释不注意更新，或者由于拷贝、粘贴引起的错误的注释，则会误导阅读人员，反而给阅读带来障碍。
除了注释要及时更新外，我们还应对注释的内容要特别关注。注释要尽量简单、清晰明了，避免使用含混晦涩的语言，同时着重注释的意义，对不太直观的部分进行注解。请见清单2。
清单2.有意义的注释
<scriptlanguage="javascript"> //followingsectionisusedtoinitializegolbalvariables(good) varvalueA=0;//initializevalueAtobesero(bad) varvalueB=1; ... //callf1functionafterwaitingfor50seconds.(good) setTimeout(f1,50000);//settimeouttobe20s(copyerror) ... </script>
这样的注释方式在JavaScript代码中经常见到。"initializevalueAtobesero"这样的注释有什么用呢？难道阅读程序的工程师从"varvalueA=0;"复制语句中看不出来么？"settimeouttobe20s"这条注释，不只是因拷贝、粘贴引起的时间大小的错误，同时也误导了程序员对这条语句的理解。setTimeout()函数的作用并非是设置函数执行的超时时间，而是等待一定时间后执行所调用的函数，害人匪浅呀。这样的注释内容宁可删掉。
此外，JavaScript的注释有两种"//"和"/*....*/"，建议"//"用作代码行注释，"/*....*/"形式用作对整个代码段的注销，或较正式的声明中，如函数参数、功能、文件功能等的描述中。
标识符命名
JavaScript中的标识符的命名规则：
以字母、下划线'_'或美元符号'$'开头
允许名称中包含字母，数字，下划线'_'和美元符号'$'
区分大小写
变量、参数、成员变量、函数等名称均以小写字母开头，构造器的名称以大写字母开头。下划线'_'开头的变量一般习惯于标识私有/局部成员。而美元符号'$'开头的变量习惯于标识系统相关，比如系统进程等。应避免用下划线'_'或美元符号'$'来命名标识符。尽可能地降低代码的阅读负担。
声明
变量的声明
尽管JavaScript语言并不要求在变量使用前先对变量进行声明。但我们还是应该养成这个好习惯。这样可以比较容易的检测出那些未经声明的变量，避免其变为隐藏的全局变量，造成隐患。
在函数的开始应先用var关键字声明函数中要使用的局部变量，注释变量的功能及代表的含义，且应以字母顺序排序。每个变量单独占一行，以便添加注释。这是因为JavaScript中只有函数的{}表明作用域，用var关键字声明的局部变量只在函数内有效，而未经var声明的变量则被视为全局变量。我们来看下清单3。
清单3.局部变量声明
<scriptlanguage="javascript">
varvalueA="a";
varvalueB="b";
functionf1(){
varvalueA="c";
alert("valueA="+valueA);//output:valueA=c
valueB="d";
alert("valueB="+valueB);//output:valueB=d
}
f1();
alert("valueA="+valueA);//output:valueA=a
alert("valueB="+valueB);//output:valueB=d
</script>
从上例的输出惊奇地发现，用var声明过的变量valueA和没有声明的变量valueB是有区别的。特别需要注意的是，在函数内部用var声明的变量为局部变量，这样可以有效地避免因局部变量和全局变量同名而产生的错误。
函数的声明
函数也应在调用前进行声明，内部函数应在var声明内部变量的语句之后声明，可以清晰地表明内部变量和内部函数的作用域。
此外，函数名紧接左括号'('之间，而右括号')'和后面的'{'之间要有个空格，以清楚地显示函数名以其参数部分，和函数体的开始。若函数为匿名/无名函数，则function关键字和左括号'('之间要留空格，否则可能误认为该函数的函数名为function。
清单4.内部函数声明
<scriptlanguage="javascript">
varinnerA=1;
functionoutF(){
varinnerA=2;
function_inF(){
alert("valueA="+innerA);
}
_inF();
}
outF();//output:valueA=2
_inF();//error:innerFisnotdefined
</script>
从清单4的输出可以看出，inF()函数仅在outF()函数的内部生效，局部变量innerA对内部函数的作用域生效。这样的编码方式使得变量和函数的作用域变得清晰。
语句
对于简单语句而言，需要提及的仍然是分号必要性，同时，一行最多有一个语句。如果一个赋值语句是用函数和对象来赋值，可能需要跨多行，一定切记要在赋值语句末加上分号。
这是因为JavaScript中，所有表达式都可以当语句，遇换行符时会解析为表达式的结束，此时不规范的换行和分号的丢失，可能引入新的错误。
对于复合语句，if,for,while,do,switch,try…catch等代码体，函数定义的函数体，对象的定义等都需要放在花括号'{}'里面。
'{'应在行末，标志代码块的开始。
'}'应在一行开头，标志代码块的结束，同时需要和'{'所在行的开始对齐，以表明一个完整的复合语句段。这样可以极大地提高代码的可阅读性，控制逻辑能清晰地表现出来。
被包含的代码段应该再缩进4个空格。
即使被包含的代码段只有一句，也应该用花括号'{}'包含。尽管不用花括号代码也不会错，但如若需要增加语句的话，则较容易因花括号遗漏而引起的编译错误或逻辑错误。
return语句在使用时也需慎重，如果用表达式的执行作为返回值，请把表达式和return放在同一行中，以免换行符被误解析为语句的结束而引起返回错误。return关键字后若没有返回表达式，则返回undefined。构造器的默认返回值为this。
清单5.return表达式
<scriptlanguage="javascript">
functionF1(){
varvalueA=1;
varvalueB=2;
returnvalueA+valueB;
}
functionF2(){
varvalueA=1;
varvalueB=2;
return
valueA+valueB;
}
alert(F1());//output:3
alert(F2());//ouput:undefined
</script>
在清单5中显示了因返回表达式没有和return关键字放在同一行而引起的返回错误，需重视。
特殊符号
空白符
适当的空白行可以大大提高代码的可阅读性，可以使代码逻辑更清晰易懂。同时，在表达式中适当的留空白，也会给代码的阅读带来方便。
关键字的后面如有括号，则最好在关键字和左括号'('之间留空白，如for,if,while等。而函数名和括号之间则不宜留空白，但若是匿名函数，则必须在function和左括号'('之间留空白，否则，编辑器会误认为函数名为function。
在表达式中，二元运算符(除左括号'('，左方括号'['，作用域点'.')和两个操作数之间最好留空白。一元运算符（若不是词typeof等）和其操作数之间不宜留空白。
逗号','的后面需要留空白，以显示明确的参数间隔，变量间隔等。
分号';'之后通常表明表达语句的结束，而应空行。在for的条件语句中，分号之后则应该留空白。
{}和[]
在JavaScript中，如需定义空对象和空数组，通常很自然地想到用newObject()和newArray()的方法。其实花括号'{}'和方括号'[]'可以直接用来定义一个空对象和一个空数组。这种书写方法可以使代码看起来简单易懂。
==和===
判断"逻辑等"在代码里太平常的不过事情了，但JavaScript与其他熟知的编程语言不同的是，除了可以使用两个等号'=='来作判断以为，还可以使用三个等号'==='来进行逻辑等判断。两者的不同是'=='作逻辑等判断时，会先进行类型转换后再进行比较。'==='则不会。因而，'=='进行的判断结果可能产生偏差。'!='与'!=='的区别亦是如此。本文提倡尽量使用'==='来进行逻辑等的判断，用'!=='进行逻辑不等的判断。
清单6.===的使用
<scriptlanguage="javascript">
varvalueA="1";
varvalueB=1;
if(valueA==valueB){
alert("Equal");
}
else{
alert("Notequal")
}
//output:"Equal"
if(valueA===valueB){
alert("Equal");
}
else{
alert("Notequal")
}
//output:"Notequal"
</script>
清单6中，valueA和valueB两个变量的值显然是不相等的，起码valueA是个字符串，而valueB是一个数字。但用'=='进行判断是，程序却输出相等的字样。这是因为编译器对两个变量进行比较时，因为他们的类型不同，而自动地将valueB转换成字符串，而后再和valueA进行比较的。用'==='得到的判断结果正和预期的结果相符。
+
加号'+'也同样是程序员所熟知的操作符之一。JavaScript和其他编程语言不同的是，在JavaScript中，'+'除了表示数字值相加，字符串相连接以外，还可以作一元运算符用，把字符串转换为数字。因而如果使用不当，则可能与自增符'++'混淆而引起计算错误。这一点，在清单7中可以清楚地看出。
清单7.巧用+号
<scriptlanguage="javascript"> varvalueA=20; varvalueB="10"; alert(valueA+valueB);//ouput:2010 alert(valueA+(+valueB));//output:30 alert(valueA++valueB);//output:30 alert(valueA++valueB);//Compileerror </script>
总结
本文就JavaScript代码的排版、命名、声明、语句、和一些特殊字符的使用等方面，谈了自己对JavaScript编程规范的建议。此外，还有许多方面需要深入了解研究，如with,eval语句和this对象的使用等等。我们在认识其普遍性的同时也需要注意其特殊性，在编写代码时多用心留意，以创造更多更优质的程序代码。