C语言中注释的示例分析

这篇文章给大家分享的是有关C语言中注释的示例分析的内容。小编觉得挺实用的,因此分享给大家做个参考,一起跟随小编过来看看吧。

错误,在C语言中注释部分对程序的运行结果不产生任何影响,它可以出现在程序的任何位置。在C语言中有两种注释方式:一种是以“/*”开始,以“*/苯崾目樽⑹?一种是以“//笨?以换行符结束的单行注释。

<强> C语言中的注释

在编写C语言源代码时,应该多使用注释,这样有助于对代码的理解。在C语言中有两种注释方式:

<李>

一种是以/*开始,以*/结束的块注释(块注释);

<李>

另一种是以//开始,以换行符结束的单行注释(评论行)。

可以使用/*和*/分隔符来标注一行内的注释,也可以标注多行的注释例。如,在下列的函数原型中,省略号的意思是开放的()函数有第三个参数,它是可选参数。注释解释了这个可选参数的用法:

int 开放(,const  char  *名字,,int 模式,,…,/*,int  permissions  */,),

可以使用//插入整行的注释,或者将源代码写成两列分栏的格式,程序在左列,注释在右列:

const  double  pi =, 3.1415926536;,,,,,,,//,π是-个常量

在C99标准中,单行注释正式加入C语言,但是大部分编译器在C99之前就已经开始支持这种用法。有时候,其被称作“C + +风格”的注释,但实际上,其源自于C的前身BCPL。

<强>注释的位置

在C语言中注释部分对程序的运行结果不产生任何影响,它可以出现在程序的任何位置。

示例:

int/* .... */我,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,//正确 　　 　　char *, s=癮bcdefgh ,,//hijklmn",,,,,,,,,,,,,,,,,,,//正确/*…*/ti,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,//错误注释会被空格替换//注意:,,,,,,,,,,,,,/*…*/不能嵌套,,/*总是与离他最近的*/匹配 　　 　　,y=x/* p ,,,,,,,,,,//,,,,,,,该语句由于没有找到*/,会报的错 　　,//要实现以上功能,,可以用y=x/(* p)或y=x, * p代替

<强>注释规范

2 - 1:一般情况下,源程序有效注释量必须在20%以上。

说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确,易懂,简洁。

2 - 2:文件头部应进行注释,注释必须列出:版权说明,版本号,生成日期,作者,内容,功能,修改日志等。

示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 　　版权:1988 - 1999年,Huawei 科技只有限公司有限公司。 　　名称:File 文件名 　　描述:,用于详细说明此程序文件完成的主要功能,与其他模块或函数的接口、输出值,取值范围,含义及参数间的控制,顺序,独立或依赖等关系 　　作者:,作者 　　版本:版本 　　日期:,完成日期 　　历史:,修改历史记录列表,,每条修改记录应包括修改日期,修改者及修改内容简述。 　　* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

2 - 3:函数头部应进行注释,列出:函数的目的/功能,输入参数,输出参数,返回值,调用关系(函数,表)等。

示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *//功能:还以为;函数名称 　　描述://,函数功能,性能等的描述 　　电话://,被本函数调用的函数清单 　　nbsp;通过://,调用本函数的函数清单 　　Table 访问://,被访问的表(此项仅对于牵扯到数据库操作的程序) 　　Table 更新://,被修改的表(此项仅对于牵扯到数据库操作的程序) 　　输入://,输入参数说明,包括每个参数的作//,用,取值说明及参数间关系。//输出:还以为,对输出参数的说明。 　　返回://,函数返回值的说明 　　其他://,其它说明 　　* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

2 - 4:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。

C语言中注释的示例分析