高效使用注释

看我文章的少侠很幸运,我写的代码一般会带注释的方便少侠们阅读:
必要的注释,可有效地提高程序的可读性,从而提高程序的可维护性。
在C语言源程序中,注释可分为三种情况:
(1)在函数体内对语句的注释;
(2)在函数之前对函数的注释;
(3)在源程序文件开始处,对整个程序的总体说明。
函数体内的语句,是由顺序结构、选择结构和循环结构等三种基本结构构成的。在什么地方加以注释的原则是:如果不加注释,理解起来就会有困难,或者虽无困难、但浪费时间。

(1)顺序结构
在每个顺序程序段(由若干条语句构成)之前,用注释说明其功能。除很复杂的处理外,一般没有必要每条语句都加以注释。
(2)选择结构
在C语言中,选择结构是由if语句和switch语句来实现的。一般地说,要在前面说明其作用,在每个分支条件语句行的后面,说明该分支的含义,如下所示:
1)if语句
/……(说明功能)/
if(条件表达式) /条件成立时的含义/
{……}
else /入口条件含义/
{……} 2)switch语句
/*……(说明功能) */
switch(表达式)

     { case  常量表达式1:     /*该入口值的含义*/
            语句组;
       ……
       case  常量表达式n:     /*该入口值的含义*/
            语句组;
       default:             /*该入口值的含义*/
            语句组; 
     }

如果条件成立时(或入口值)的含义,已经很明确了,也可不再加以注释。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章