上QQ阅读APP看书,第一时间看更新
2.4 注释
JavaScript程序有两类注释:单行注释(//)和多行注释(/*…*/),这些注释方法跟C、C++及Java都是类似的。
1.单行注释
单行注释可以注释整行或者某一行中的一部分。它一般不用于注释连续多行,然而,可以用它来注释掉连续多行的代码段。以下是几种注释风格的例子:
if x > 1 { //注释1 } else { return false; //注释2 } //if x > 1 { // //注释1 //} else { // return false; //注释2 //}
2. 块注释
一般用于连续多行的注释,但它也可以对单行进行注释。以下是几种注释风格的例子:
if x > 1 { /* 注释1 */ } else { return false; /* 注释2 */ } /* if x > 1 { //注释1 } else { return false; //注释2 } */ /* if x > 1 { /* 注释1 */ } else { return false; /* 注释2 */ } */
JavaScript多行注释有一个其他语言没有的优点,就是它们可以嵌套,上述示例的最后一种情况是实现了多行注释嵌套。
对容易引起误解的代码,进行注释是必要的,但应避免对已清晰表达信息的代码进行注释。需要注意的是,频繁的注释有时反映出代码质量低。当你觉得被迫要反复注释的时候,可考虑重写代码以使其更清晰。