3.2 C程序的注釋

代碼3-1出現最多的是“/*”和“*/”包裹起來的中文語句，這些是注釋。注釋是用來幫助程序員閱讀源代碼和理解源代碼的。編譯器在編譯源代碼的時候，在目標代碼生成以前，會把注釋剔除掉，然后再進行編譯。當然編譯器是不會修改源文件的，這一切是在內存中完成。由于對于注釋部分忽略不處理，就如同沒有這些字符一樣，所以注釋不會增加編譯后的程序的可執行代碼長度，對程序運行不起任何作用。

對于注釋，有以下幾點說明：

（1）C語言的注釋只有一種形式，就是以“/*”開始、以“*/”結束的注釋對。

（2）編譯器將“/*”與“*/”之間的任何文字，如代碼、標點符號、制表符、換行等都當作注釋不予以處理。例如：

/*這段注釋里 含有空格*/
/*這段注釋里         含有制表符*/
/*這段注釋里有換
行*/
/*這
段
注
釋
很
長
跨
越
很
多
行
*/

（3）注釋可以放在任何地方。通常，把注釋置于要描述的代碼段之前比較合適，而將變量的用途注釋則放在變量定義后面。

/*本變量的用途是記錄學生人數*/
int i_numbers;
int i_numbers /*學生人數*/
int x, /*這段注釋在代碼之中*/ y;

注意 最后一行注釋處于代碼int x和y之間，這也是容許的。

（4）注釋和代碼一定要同步更新。代碼修改而注釋不做改變，這樣的事情在實際開發中經常看見，而這樣的情況可能會帶來嚴重不良后果。

（5）注意注釋的起始和結束對，在“/*”、“*/”兩個字符之間是沒有空格的。如果出現空格，如“/ *”，“* /”，則不是注釋了。

（6）注釋內部不能再出現注釋對。如：

/*這是一個注釋起始。/*又出現一個注釋起始*/嵌套的注釋結束*/
/*這是一個注釋起始。*/再出現一個注釋結束*/

解決這種嵌套注釋的方法，就是在內層“/*”或者“*/”之間添加空格。

留給讀者一個問題：“/**”、“//*”、“**/”哪些可以構成注釋，哪些不能構成注釋呢？

（7）適量而恰當的注釋是良好編程風格的重要體現，是一種程序規范，可以用來概括程序的算法、標識變量和函數的意義，或者解釋一段代碼的意圖。但是在代碼中混雜過多的注釋也許會使得程序更難于理解。如下的代碼片段用了過多的注釋，反而影響了代碼的閱讀。

/*定義長方形的長和寬*/
/*在計算面積的時候*/
/*需要使用長和寬*/
/*在計算周長的時候*/
/*也需要長和寬*/
/*如果長和寬相同*/
/*則此長方形就是一個正方形*/
int i_height, i_weight;