看我文章的少俠很幸運,我寫的代碼一般會帶註釋的方便少俠們閱讀:
必要的註釋,可有效地提高程序的可讀性,從而提高程序的可維護性。
在C語言源程序中,註釋可分爲三種情況:
(1)在函數體內對語句的註釋;
(2)在函數之前對函數的註釋;
(3)在源程序文件開始處,對整個程序的總體說明。
函數體內的語句,是由順序結構、選擇結構和循環結構等三種基本結構構成的。在什麼地方加以註釋的原則是:如果不加註釋,理解起來就會有困難,或者雖無困難、但浪費時間。
(1)順序結構
在每個順序程序段(由若干條語句構成)之前,用註釋說明其功能。除很複雜的處理外,一般沒有必要每條語句都加以註釋。
(2)選擇結構
在C語言中,選擇結構是由if語句和switch語句來實現的。一般地說,要在前面說明其作用,在每個分支條件語句行的後面,說明該分支的含義,如下所示:
1)if語句
/……(說明功能)/
if(條件表達式) /條件成立時的含義/
{……}
else /入口條件含義/
{……} 2)switch語句
/*……(說明功能) */
switch(表達式)
{ case 常量表達式1: /*該入口值的含義*/
語句組;
……
case 常量表達式n: /*該入口值的含義*/
語句組;
default: /*該入口值的含義*/
語句組;
}
如果條件成立時(或入口值)的含義,已經很明確了,也可不再加以註釋。