注释

　　代码中的注释很重要，自然也是毋庸置疑的。通常我们会强调代码中注释数量的多少，而轻视了对注释质量的提高。编码是及时添加注释，会给后续代码的维护人员带来很大的便利。但是如果注释不注意更新，或者由于拷贝、粘贴引起的错误的注释，则会误导阅读人员，反而给阅读带来障碍。

　　除了注释要 及时更新外，我们还应对注释的内容要特别关注。注释要尽量简单、清晰明了，避免使用含混晦涩的语言，同时着重 注释的意义，对不太直观的部分进行注解。请见清单 2。

　　清单 2. 有意义的注释

<script language="javascript">  
//following section is used to initialize golbal variables             (good)  
var valueA = 0;     //initialize  valueA to be sero                       (bad)  
var valueB = 1;  
...  
//call f1 function after waiting for 50 seconds.                         (good)  
setTimeout(f1,50000); //set timeout to be 20s                     (copy error)  
...  
</script>  

　　这样的注释方式在 JavaScript 代码中经常见到。"initialize valueA to be sero" 这样的注释有什么用呢?难道阅读程序的工程师从"var valueA = 0;"复制语句中看不出来么?"set timeout to be 20s"这条注释，不只是因拷贝、粘贴引起的时间大小的错误，同时也误导了程序员对这条语句的理解。setTimeout() 函数的作用并非是设置函数执行的超时时间，而是等待一定时间后执行所调用的函数，害人匪浅呀。这样的注释内容宁可删掉。

　　此外，JavaScript 的注释有两种"//" 和"/* .... */"，建议"//"用作代码行注释，"/* .... */"形式用作对整个代码段的注销，或较正式的声明中，如函数参数、功能、文件功能等的描述中。

　　标识符命名

　　JavaScript 中的标识符的命名规则：

　　以字母、下划线'_'或美元符号'$'开头

　　允许名称中包含字母，数字，下划线'_'和美元符号'$'

　　区分大小写

　　变量、参数、成员变量、函数等名称均以小写字母开头，构造器的名称以大写字母开头。下划线'_'开头的变量一般习惯于标识私有 / 局部成员。而美元符号'$'开头的变量习惯于标识系统相关，比如系统进程等。应避免用下划线'_'或美元符号'$'来命名标识符。尽可能地降低代码的阅读负担。

　　声明

　　变量的声明

　　尽管 JavaScript 语言并不要求在变量使用前先对变量进行声明。但我们还是应该养成这个好习惯。这样可以比较容易的检测出那些未经声明的变量，避免其变为隐藏的全局变量，造成隐患。

　　在函数的开始应先用 var 关键字声明函数中要使用的局部变量，注释变量的功能及代表的含义，且应以字母顺序排序。每个变量单独占一行，以便添加注释。这是因为 JavaScript 中只有函数的 {} 表明作用域，用 var 关键字声明的局部变量只在函数内有效，而未经 var 声明的变量则被视为全局变量。我们来看下清单 3。

　　清单 3. 局部变量声明

<script language="javascript">  
 var valueA  = "a";  
 var valueB  = "b";  
 function f1() {  
   var valueA = "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>