【共讀Primer】3.<1.3>註釋簡介 Page8

C++的註釋有兩種

1.  雙斜杠開始到本行結束 （//）

2. 斜杠星開始 星斜杠結束 （/*）（*/）

 1 #include <iostream> // 標準庫中輸入輸出流的庫名稱
 2 /*
 3  * 簡單主函數：
 4  * 讀取兩個數，求它們的和
 5  */
 6 int main()
 7 {
 8     std::cout << "Enter two numbers:" << std::endl;// 輸出一個提示信息的字元串，併在結尾換行
 9     int v1 = 0, v2=0;// 聲明兩個int型的變數，都賦值為0
10     std::cin >> v1 >> v2;// 從鍵盤輸入中讀取兩個數字，分別寫入v1和v2兩個變數中
11     std::cout << "The sum of " << v1 << " and " << v2// 與下一行是一條命令
12                    << " is " << v1 + v2 << std::endl;// 輸出v1、v2的值，並且輸出兩數之和的值
13     return 0;
14 }

我們把上次的代碼加上一個比較詳細的註釋。

註釋的目的： 讓代碼閱讀者更清晰的理解編碼者的代碼意義。

註釋的一種錯誤用法   ，/* */的嵌套使用

/*
 * 註釋對 /* */ 不能嵌套。
 * “不能嵌套” 幾個字會被認為是源碼，
 * 象剩餘程式一樣處理
 */
int main()
{
   return 0  
}

大家看一下代碼著色就能發現，嵌套使用後的註釋對會出現問題。

從以往的編碼經驗中得到關於註釋的經驗有以下幾點：

1. 註釋並不是越多越好，能很好自解釋的代碼就沒有必要寫註釋，而對於複雜的演算法或邏輯關係應該寫清楚

2. 註釋最重要的一點是給別人，或者以後的自己看，所以要保證讀者能夠在儘量短的時間內理解

3. 註釋的代碼一致性也是很重要的，修改代碼的同時一定要修改註釋，否則寧願沒有註釋