C语言程序中的注释格式由什么组成

C语言程序中的注释格式由什么组成,第1张

C语言标准

最初只有一种注释

就是以/开始 到/结束。 中间部分 都是注释。

后来增加了行注释

以//开始。 //之后的整行 都是注释。

目前//用的更多一些。

以注释内容开始。

关于程序中注释书写格式

1程序文件注释:

放在程序名称空间引用(using SystemIO;)的上面,主要写公司的版权、文件创建的时间、文件的主要内容、文件的名字、文件的创建标识(创建人姓名)、文件修改的时间、文件修改时的修改标识(修改人姓名)、文件修改的修改原因等(详情见文档后备注示例);

2类的作用注释:

放在类(类、接口、枚举、结构体)的声明上方,主要描述类的作用。

如果类的结构比较复杂,也应该添加类的使用示例和类的流程(其它特点)

3、类的私有全局重要变量注释:

放在类的全局变量声明上方,主要需要注释通过命名不能正确理解的全局私有或公有(包含受保护等)变量。如果是object(特殊数组等)型变量,内部使用时结构比较复杂或有规定,需要简要的说明一下内部结构。

4、类的属性的注释:

放在类的属性声明上方,简要说明属性的类型和主要作用。

5、类的公有方法的注释:

主要说明方法的作用,方法各参数的意义和要求,方法的返回值及各种可能的返回值的特殊意义,方法可能会产生的异常,如果需要,则可以写出方法的使用示例;

6、类的私有方法或重要算法的注释:

除了需要说明公有方法所要求的之外,如果算法、数学运算比较复杂,需要写出算法或数学方法的理论过程或推导过程;如果算法比较长,要尽可能的细分成逻辑块,并填写适当的注释;对于方法中的重要变量也要添加适当的注释,特别是对方法的结果或方法某一段的结果的方法内部不易理解的变量要添加合适的注释;对于特别复杂(重要)的方法,要添加适当的流程图或文档,给以充分的文字、图解等说明;

7、文件、类或类的方法修改后的注释的变更:

对于对文件或类(包括接口、枚举、结构体)或类的方法修改后,要添加修改后的相注释,要写清修改的时间、修改标识(修改人姓名)、修改的原因等一切必要的信息和一切必要变更的信息(类、方法的流程);

c++中有两种注释方式,一种是“//”,这种注释意味着注释起始处,所有位于“//”及该行末尾之间的内容都是注释。另一种是“//”在这两个符合之间的内容为注释。前一种方法正常用于最终的代码中,后一种正常用于调试程序时用,作为暂时性的注释。

下面给出一个简单的Java程序范例,了解Java程序的基本结构。

package zknu;

/

@param TestJavaStructurejava

@author chenzhanwei

@version v10

/

class Circle{ // 定义一个圆形类

final float PI = 31415f; // 声明一个float型常量

int r = 3; // 声明一个int型变量,初始化值为3

/public float perimeter(int r){ // 求圆周长的方法

return 2PIr;

}/

public float area(int r){ // 求圆面积的方法

return PIrr;

}

}

public class TestJavaStructure {

public static void main(String[] args) {

Circle c = new Circle(); // 创建Circle的实例化对象

cr = 6; // 给类的成员变量r赋值

// Systemoutprintln("圆的周长为:" + cperimeter(cr));

Systemoutprintln("圆的面积为:" + carea(cr));

}

}

程序运行结果:

圆的面积为:113093994

程序说明:

1.程序的注释有助于提高程序的可读性,还可以屏蔽掉一些暂时不用的语句,等需要时直接取消此语言的注释即可,在Java中根据功能不同,分为单行注释、多行注释(或者叫块注释)、文档注释3种。下面分别介绍。

(1)文档注释

程序中“/ 注释内容 /”形式为文档注释,这种方法注释的内容会被解释成程序的正式文档,并能包含在如javadoc之类工具生成的文档中,用以说明该程序。

(2)单行注释

在注释内容前面加“//”,Java编译器会忽略掉这部分信息,如程序中下面的语句:

final float PI = 31415f; // 声明一个float型常量

(3)多行注释

在注释内容前面加“/”,在注释内容后面加“/”,一般注释内容为多行。如程序中对圆周长方法的注释就是多行注释。

2.class 和 public class

是Java中的关键字,在Java中声明一个类的方式主要有两种,即class 类名称和public class类名称。

类是Java的基本存储单元,在Java中所有的 *** 作都是由类组成的。一般习惯把main方法放在public class声明的类中,public static void main(String[] args)是程序的主方法,即所有的程序都以此方法作为起点并运行下去。public class类名称的“类名称”必须与文件名相同。

在一个Java文件中可以有多个class类的定义,但是只能有一个public class的定义。

以上就是关于C语言程序中的注释格式由什么组成全部的内容,包括:C语言程序中的注释格式由什么组成、c语言中可以对程序进行注释,注释部分如果占多行,必须以什么开始、c++程序代码注释,高手进,高分等相关内容解答,如果想了解更多相关内容,可以关注我们,你们的支持是我们更新的动力!

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

原文地址: http://outofmemory.cn/zz/10179587.html

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

发表评论

登录后才能评论

评论列表(0条)

保存