本節書摘來自異步社群出版社《c++入門經典(第5版•修訂版)》一書中的第2章,第2.3節,作者:【美】jesse liberty , rogers cadenhead,更多章節内容可以通路雲栖社群“異步社群”公衆号檢視。
c++入門經典(第5版•修訂版)
在您編寫程式時,每行源代碼的功能顯而易見,但随着時間的流逝,再回過頭來修複程式bug或添加新功能時,常常會發現對自己以前做的工作感到一頭霧水。
為避免這種困境,并幫助他人了解您編寫的代碼,可在源代碼中添加注釋。注釋是闡述程式做什麼的文本,編譯器對其置之不理,是以隻能給閱讀代碼的人帶來好處。
在c++中,有兩種類型的注釋。單行注釋以兩個斜杆(//)打頭,導緻編譯器忽略從這裡開始到行尾的全部内容,下面是一個例子:

多行注釋以斜杠和星号(/)打頭,并以星号和斜杆(/)結尾。/和/之間的所有内容都是注釋,哪怕它們占據多行。如果程式中不存在與/配套的/,編譯器将視之為錯誤。下面是一個多行注釋:
在上述注釋中,為提高可讀性,讓文本左對齊,但并非必須這樣,因為編譯器忽略/和/之間的所有内容。在這裡,可包含任何内容:雜貨清單、情詩、從未告訴過别人的秘密等。
警告:
關于多行注釋,需要牢記的一個重點是,不能将其嵌套。如果您使用/開始注釋,并在幾行後又使用了一個/ ,則編譯器見到第一個/後,将認為多行注釋到此結束,這樣第二個/将導緻編譯器錯誤。大多數c++編輯器都以不同的顔色顯示注釋,讓注釋的開始和結束位置非常清晰。
在稍後您将建立的項目中,包含了這兩種類型的注釋。請在程式中添加大量注釋,您為解釋代碼的功能而在編寫注釋上花的時間越多,幾周、幾月甚至幾年後,代碼就越容易了解。