C++ 入門筆記：註解語法與最佳實踐

兩種註解形式

C++ 提供兩種註解風格，編譯器會完全忽略它們，不影響執行檔大小。

1. 單行註解 //

從 // 到行尾皆為註解。

std::cout << "Enter two numbers: "; // 提示使用者輸入
int v1, v2; // 宣告變數
std::cin >> v1 >> v2; // 讀取輸入

2. 成對註解 /* ... */ (C 風格)

跨行區塊註解，可置於任何空白字元合法位置。

/* 簡單的 main 函數：讀入兩個數字並輸出結果 */
int main() {
    // ...
}

習慣上多行註解每行以 * 開頭，明確標示範圍：

/*
 * 這是一段多行說明
 * 詳細描述演算法邏輯
 * 或模組用途
 */

常見用法慣例

• 成對註解： 檔案標頭、函數說明、複雜演算法區塊解釋、暫時大段停用代碼。
• 單行註解： 變數用途、單行邏輯備註、行尾附註。

重要限制：成對註解不可巢狀

/*
 * 註解 /* 內嵌註解 */ 無法編譯
 * "無法編譯" 會被視為原始碼導致錯誤
 */

解決方案： 暫時停用含註解的代碼區塊時，使用編輯器批次加上 //，而非外層包 /* */。

註解維護鐵律

1. 隨代碼更新： 修改邏輯時同步修改對應註解。
2. 寧無勿錯： 錯誤/過時的註解比無註解更有害，會誤導維護者。
3. 精準簡潔： 解釋「為什麼」與「非顯而易見的怎麼做」，避免重述代碼字面意義。

練習題

1. 嘗試編譯含巢狀成對註解的程式，觀察錯誤訊息。
2. 判斷下列輸出語句合法性：
   std::cout << "/*";
std::cout << "*/";
std::cout << /* "*/" */; (第三行非法，字串常數被註解截斷)