《編寫可維護的JavaScript》——2.2 多行注釋

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

多行注釋可以包裹跨行文本。它以/開始，以/結束。多行注釋不僅僅可以用來包裹跨行文本，這取決于你。下面這些都是合法的注釋。

盡管從技術的角度看，這些注釋都是合法的，但我比較青睐java風格的多行注釋。java風格的注釋至少包含三行：第一行是/，第二行是以開始且和上一行的保持左對齊，最後一行是/。這種注釋看起來像下面這樣。

通過在注釋塊左側注上星号，會讓注釋更加清晰。有一些ide（比如netbean和eclipse）會為你自動插入這些星号。

多行注釋總是會出現在将要描述的代碼段之前，注釋和代碼之間沒有空行間隔。和單行注釋一樣，多行注釋之前應當有一個空行，且縮進層級和其描述的代碼保持一緻。來看下面這段例子。