1.2.4 注釋

程序 Ex_Simple 中的“/*...*/”之間的內容或“//”開始一直到行尾的內容是用來注釋的。在 C++中，“/*...*/”是用來實現多行的注釋，它是將由“/*”開頭到“*/”結尾之間所有內容均視為注釋，稱為塊注釋。塊注釋（“/*...*/”）的注解方式可以出現在程序中的任何位置，包括在語句或表達式之間。而“//”只能實現單行的注釋，它是將“//”開始一直到行尾的內容作為注釋，稱為行注釋。

注釋的目的只是為了提高程序的可讀性，對編譯和運行并不起作用。正是因為這一點，所注釋的內容既可以用中文來表示，也可以用英文來說明，只要便于理解就行。

一般來說，注釋應在編程的過程中同時進行，不要指望程序編制完成后再補寫注釋。那樣只會多花好幾倍的時間，更為嚴重的是，時間長了以后甚至會讀不懂自己編寫的程序。

通常，必要的注釋內容應包含：

（1）在源文件頭部進行必要的源程序的總體注釋：版權說明、版本號、生成日期、作者、內容、功能、與其他文件的關系、修改日志等，頭文件的注釋中還應有函數功能簡要說明。

（2）在函數的頭部進行必要的函數注釋：函數的目的/功能、輸入參數、輸出參數、返回值、調用關系（函數、表）等。

（3）其他的少量注釋：如全局變量的功能、取值范圍等。千萬不要陳述那些一目了然的內容，否則會使注釋的效果適得其反。