c语言中可以对程序进行注释,注释部分如果占多行,必须以什么开始?

c语言中可以对程序进行注释,注释部分如果占多行,必须以什么开始?,第1张

注释内容开始。
关于程序中注释书写格式
1程序文件注释:
放在程序名称空间引用(using SystemIO;)的上面,主要写公司的版权、文件创建的时间、文件的主要内容、文件的名字、文件的创建标识(创建人姓名)、文件修改的时间、文件修改时的修改标识(修改人姓名)、文件修改的修改原因等(详情见文档后备注示例);
2类的作用注释:
放在类(类、接口、枚举、结构体)的声明上方,主要描述类的作用。
如果类的结构比较复杂,也应该添加类的使用示例和类的流程(其它特点)
3、类的私有全局重要变量注释:
放在类的全局变量声明上方,主要需要注释通过命名不能正确理解的全局私有或公有(包含受保护等)变量。如果是object(特殊数组等)型变量,内部使用时结构比较复杂或有规定,需要简要的说明一下内部结构。
4、类的属性的注释:
放在类的属性声明上方,简要说明属性的类型和主要作用。
5、类的公有方法的注释:
主要说明方法的作用,方法各参数的意义和要求,方法的返回值及各种可能的返回值的特殊意义,方法可能会产生的异常,如果需要,则可以写出方法的使用示例;
6、类的私有方法或重要算法的注释:
除了需要说明公有方法所要求的之外,如果算法、数学运算比较复杂,需要写出算法或数学方法的理论过程或推导过程;如果算法比较长,要尽可能的细分成逻辑块,并填写适当的注释;对于方法中的重要变量也要添加适当的注释,特别是对方法的结果或方法某一段的结果的方法内部不易理解的变量要添加合适的注释;对于特别复杂(重要)的方法,要添加适当的流程图或文档,给以充分的文字、图解等说明;
7、文件、类或类的方法修改后的注释的变更:
对于对文件或类(包括接口、枚举、结构体)或类的方法修改后,要添加修改后的相注释,要写清修改的时间、修改标识(修改人姓名)、修改的原因等一切必要的信息和一切必要变更的信息(类、方法的流程);

C程序注释是由 / 和 /所界定的文字信息组成的。

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

1、一种是以/开始、以/结束的块注释(block comment);

2、另一种是以//开始、以换行符结束的单行注释(line comment)。

可以使用/和/分隔符来标注一行内的注释,也可以标注多行的注释。

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

int open( const char name, int mode, … / int permissions / );

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

const double pi = 31415926536;       // pi是—个常量

扩展资料

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

1、在引号中,如果采用/或//分隔一个字符常量或字符串字面量(string literal),它们都不会被视为注释的开始。例如,下面语句就没有注释:

printf("Comments in C begin with / or //\n" );

2、预处理器仅通过检查注释的结束符来检测注释中的字符,因此,不能嵌套块注释。然而,可以使用/和/注释包含单行注释的源代码:

/ 暂时注释掉这两行:

  const double pi = 31415926536;  // pi是一个常量

  area = pi r r;   // 计算面积

暂时注释到此 /


欢迎分享,转载请注明来源:内存溢出

原文地址: https://outofmemory.cn/yw/13390015.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-07-27
下一篇 2023-07-27

发表评论

登录后才能评论

评论列表(0条)

保存