第02章 注釋

JavaScript支持兩種不同類型的注釋，單行注釋和多行注釋

2.1 單行注釋

獨(dú)占一行的注釋，用來解釋下一行代碼。這行注釋之前要有一個空行，且縮進(jìn)層級和下一行的代碼保持一致。
在代碼行尾部的注釋，代碼結(jié)束到注釋之間至少一個縮進(jìn)。但該行的總長度不應(yīng)該超過單行最大長度，如果超了，就將注釋放到該行代碼上方。
被注釋掉的大段代碼。這種情況不建議使用多行注釋。

// 好的做法 注釋前要有空行  注釋要與被注釋的代碼相同縮進(jìn)  
if(con){

    // 如果代碼執(zhí)行到這里，。。。
    allowed();
}

// 好的寫法  注釋寫在代碼后面時，要與代碼之間有間隔
var result = something + somethingElse; // somethingElse不應(yīng)當(dāng)取值為null。

// 好的做法 注釋掉大段代碼 要使用單行注釋 不建議使用多行注釋
// if(con){
//  allowed();
// }

2.2 多行注釋

多行注釋可以包裹跨行文本。它以/開始/結(jié)束

/* 我是注釋 */
/* 另一段注釋 */

多行注釋建議使用以下格式：

/*
 * 多行注釋
 * 該注釋包含兩行
 */

2.3 使用注釋

添加注釋的一般原則：在需要讓代碼更清晰時添加注釋
難于理解的代碼
可能被誤認(rèn)為是錯誤的代碼
瀏覽器特效hack

2.4 文檔注釋

如果想導(dǎo)出幫助文檔API文件，那么就可以在方法或類的前面使用文檔注釋
文檔注釋有很多種格式，但最流行的一種格式來自于JavaDoc文檔格式：多行注釋以單斜線加雙星號（/**）開始，
一般編輯器只要鍵入/**后enter回車就好