評論

一個評論是將原始碼內任意的文字，而無需 C++編譯器的任何功能意義解釋它的一種方式。註釋用於深入瞭解程式的設計或方法。

C++中有兩種型別的註釋：

單行評論

雙正斜槓序列//將標記所有文字，直到換行作為註釋：

int main()
{
   // This is a single-line comment.
   int a;  // this also is a single-line comment
   int i;  // this is another single-line comment
}

C 風格/塊評論

序列/*用於宣告註釋塊的開始，序列*/用於宣告註釋的結束。即使文字是有效的 C++語法，開始和結束序列之間的所有文字都被解釋為註釋。這些有時被稱為“C 風格”註釋，因為這個註釋語法繼承自 C++的前身語言 C：

int main()
{
   /*
    *  This is a block comment.
    */
   int a;
}

在任何塊註釋中，你可以編寫任何你想要的內容。當編譯器遇到符號*/時，它會終止塊註釋：

int main()
{
   /* A block comment with the symbol /*
      Note that the compiler is not affected by the second /*
      however, once the end-block-comment symbol is reached,
      the comment ends.
   */
   int a;
}

上面的例子是有效的 C++（和 C）程式碼。但是，在塊註釋中包含額外的/*可能會導致某些編譯器發出警告。

塊註釋也可以在一行內開始和結束。例如：

void SomeFunction(/* argument 1 */ int a, /* argument 2 */ int b);

評論的重要性

與所有程式語言一樣，註釋提供了幾個好處：

• 明確的程式碼文件，使其更易於閱讀/維護
• 解釋程式碼的目的和功能
• 有關程式碼背後的歷史或推理的詳細資訊
• 直接在原始碼中放置版權/許可證，專案說明，特別感謝，貢獻者積分等。

但是，評論也有其缺點：

• 必須維護它們以反映程式碼中的任何更改
• 過多的註釋往往會降低程式碼的可讀性

通過編寫清晰的自我記錄程式碼可以減少對註釋的需求。一個簡單的例子是對變數，函式和型別使用解釋性名稱。將邏輯相關的任務分解為離散函式與此相輔相成。

註釋標記用於禁用程式碼

在開發過程中，註釋還可用於快速禁用部分程式碼而不刪除它。這通常對測試或除錯有用，但對於臨時編輯以外的任何其他方式都不是好的樣式。這通常被稱為評論。

類似地，將一段程式碼的舊版本保留在註釋中用於參考目的是不受歡迎的，因為與通過版本控制系統探索程式碼的歷史相比，它在提供很少價值的同時使檔案變得混亂。