编写可维护的JavaScript－第2章－注释

1.单行注释

• 单独一行的单行注释前一行应该为空
• 单独一行的单行注释应该和要解释的一行缩进相同
• 和代码在一行的单行注释应和代码有间隔
• 数行的单行注释应该直接变成多行注释

2.多行注释

/*
 * blablabla
 * blablabla
 */

其他的原则和单行注释一样

3.何时应该使用注释

• 难以理解的代码
• 可能被误认为错误的代码

4.文档注释

/**
文档注释blabla
@重要属性1 这个属性1blabla
@重要属性2 这个属性2blabla
**/

当使用文档注释的时候，要确保

• 所有方法
• 所有构造函数
• 所有包含方法的对象

都有文本注释