编写可维护的javascript（二）：注释

单行注释

// good
if (condition) {

// 如果执行到这里，则表明通过了所有安全性检查
allowed();
}

// bad (注释之前没有空行)
if (condition) {
// 如果执行到这里，则表明通过了所有安全性检查
allowed();
}

多行注释

// good (最标准的写法)
if (condition) {

/*
*如果代码执行到这里
*说明通过了所有安全性检查
*/
allowed();
}

// bad (注释前每空行)
if (condition) {
/*
*如果代码执行到这里
*说明通过了所有安全性检查
*/
allowed();
}

使用注释

使用注释的指导原则是：

1、当代码不清晰时添加注释，而代码很明了的时候不应当添加注释。

2、难于理解的代码

3、可能被认为错误的代码

4、浏览器特性hack

文章内容从《编写可维护的Javascript》[美] Nicholas C. Zakas著 一书中总结写出。