《編寫可維護的JavaScript》——第 2 章 注釋 2.1單行注釋

本節書摘來自異步社群《編寫可維護的javascript》一書中的第2章，第2.1節，作者：【美】nicholas c. zakas著，更多章節内容可以通路雲栖社群“異步社群”公衆号檢視

注釋是代碼中最常見的組成部分。它們是另一種形式的文檔，也是程式員最後才舍得花時間去寫的。但是，對于代碼的總體可維護性而言，注釋是非常重要的一環。打開一個沒有任何注釋的檔案就好像趣味冒險，但如果給你的時間有限，這項任務就變成了折磨。适度的添加注釋可以解釋說明代碼的來龍去脈，其他開發者就可以不用從頭開始讀代碼，而是直接去讀代碼的任意部分。程式設計風格通常不會包含對注釋的風格約定，但我認為從注釋的作用即可看出它們的重要性不容忽視。

javascript支援兩種不同類型的注釋：單行注釋和多行注釋。

單行注釋以兩個斜線開始，以行尾結束。

<code>// 這是一句單行注釋</code>

很多人喜歡在雙斜線後敲入一個空格，用來讓注釋文本有一定的偏移。單行注釋有三種使用方法。

獨占一行的注釋，用來解釋下一行代碼。這行注釋之前總是有一個空行，且縮進層級和下一行代碼保持一緻。

在代碼行的尾部的注釋。代碼結束到注釋之間至少有一個縮進。注釋（包括之前的代碼部分）不應當超過單行最大字元數限制，如果超過了，就将這條注釋放置于目前代碼行的上方。

被注釋掉的大段代碼（很多編輯器都可以批量注釋掉多行代碼）。

單行注釋不應當以連續多行注釋的形式出現，除非你注釋掉一大段代碼。隻有當需要注釋一段很長的文本時才使用多行注釋。

這裡有一些示例代碼。