c语言入门代码含注释(c语言必背入门代码含注释)

http://www.itjxue.com  2023-03-17 05:29  来源:未知  点击次数: 

C语言程序注释

C语言编程规范-注释

规则:

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

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

2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。

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

/*************************************************

Copyright (C), 1988-1999, Tech. Co., Ltd.

File name: // 文件名

Author:

Version:

Date: // 作者、版本及完成日期

Description: // 用于详细说明此程序文件完成的主要功能,与其他模块

// 或函数的接口,输出值、取值范围、含义及参数间的控

// 制、顺序、独立或依赖等关系

Others: // 其它内容的说明

Function List: // 主要函数列表,每条记录应包括函数名及功能简要说明

1. ....

History: // 修改历史记录列表,每条修改记录应包括修改日期、修改

// 者及修改内容简述

1. Date:

Author:

Modification:

2. ...

*************************************************/

3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。

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

/************************************************************

Copyright (C), 1988-1999, Tech. Co., Ltd.

FileName: test.cpp

Author:

Version :

Date:

Description: // 模块描述

Version: // 版本信息

Function List: // 主要函数及其功能

1. -------

History: // 历史修改记录

author time version desc

David 96/10/12 1.0 build this moudle

***********************************************************/

说明:Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。

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

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

/*************************************************

Function: // 函数名称

Description: // 函数功能、性能等的描述

Calls: // 被本函数调用的函数清单

Called By: // 调用本函数的函数清单

Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序)

Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序)

Input: // 输入参数说明,包括每个参数的作

// 用、取值说明及参数间关系。

Output: // 对输出参数的说明。

Return: // 函数返回值的说明

Others: // 其它说明

*************************************************/

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

6:注释的内容要清楚、明了,含义准确,防止注释二义性。

说明:错误的注释不但无益反而有害。

7:避免在注释中使用缩写,特别是非常用缩写。

说明:在使用缩写时或之前,应对缩写进行必要的说明。

8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

示例:如下例子不符合规范。

例1:

/* get replicate sub system index and net indicator */

repssn_ind = ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

例2:

repssn_ind = ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

/* get replicate sub system index and net indicator */

应如下书写

/* get replicate sub system index and net indicator */

repssn_ind = ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。

示例:

/* active statistic task number */

#define MAX_ACT_TASK_NUMBER 1000

#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */

10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。

示例:可按如下形式说明枚举/数据/联合结构。

/* sccp interface with sccp user primitive message name */

enum SCCP_USER_PRIMITIVE

{

N_UNITDATA_IND, /* sccp notify sccp user unit data come */

N_NOTICE_IND, /* sccp notify user the No.7 network can not */

/* transmission this message */

N_UNITDATA_REQ, /* sccp user's unit data transmission request*/

};

11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

示例:

/* The ErrorCode when SCCP translate */

/* Global Title failure, as follows */ // 变量作用、含义

/* 0 - SUCCESS 1 - GT Table error */

/* 2 - GT error Others - no use */ // 变量取值范围

/* only function SCCPTranslate() in */

/* this modual can modify it, and other */

/* module can visit it through call */

/* the function GetGTTransErrorCode() */ // 使用方法

BYTE g_GTTranErrorCode;

12:注释与所描述内容进行同样的缩排。

说明:可使程序排版整齐,并方便注释的阅读与理解。

示例:如下例子,排版不整齐,阅读稍感不方便。

void example_fun( void )

{

/* code one comments */

CodeBlock One

/* code two comments */

CodeBlock Two

}

应改为如下布局。

void example_fun( void )

{

/* code one comments */

CodeBlock One

/* code two comments */

CodeBlock Two

}

13:将注释与其上面的代码用空行隔开。

示例:如下例子,显得代码过于紧凑。

/* code one comments */

program code one

/* code two comments */

program code two

应如下书写

/* code one comments */

program code one

/* code two comments */

program code two

14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。

说明:这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。

15:对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。

说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。

示例(注意斜体加粗部分):

case CMD_UP:

ProcessUp();

break;

case CMD_DOWN:

ProcessDown();

break;

case CMD_FWD:

ProcessFwd();

if (...)

{

...

break;

}

else

{

ProcessCFW_B(); // now jump into case CMD_A

}

case CMD_A:

ProcessA();

break;

case CMD_B:

ProcessB();

break;

case CMD_C:

ProcessC();

break;

case CMD_D:

ProcessD();

break;

...

建议:

1:避免在一行代码或表达式的中间插入注释。

说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。

2:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。

说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。

3:在代码的功能、意图层次上进行注释,提供有用、额外的信息。

说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。

示例:如下注释意义不大。

/* if receive_flag is TRUE */

if (receive_flag)

而如下的注释则给出了额外有用的信息。

/* if mtp receive a message from links */

if (receive_flag)

4:在程序块的结束行右方加注释标记,以表明某程序块的结束。

说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。

示例:参见如下例子。

if (...)

{

// program code

while (index MAX_INDEX)

{

// program code

} /* end of while (index MAX_INDEX) */ // 指明该条while语句结束

} /* end of if (...)*/ // 指明是哪条if语句结束

5:注释格式尽量统一,建议使用"/* …… */"。

6:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。

说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。

C语言代码求注释及解释

#includestdio.h

void

fun(char*t,char*s)

{

while(*t!=0)t++;//如果*t指向的字符不为空则地址加加,只是为了把指针直到ss的末尾,字符串是以'\0'为结束符的,并且(*t!=0)其实就是*t!='\0',这句执行完后,指针就指向了'\0'的位置

while(*t++=*s++)!=0);//在t指向的字符串尾部把s指向的字符串拼接上。第一次,把s字符串的第一个字符赋给t,记住,这时候t已经是指向了'\0'的位置,然后指针s和指针t都加一,则他们指向的位置都会向后移动一个字节,直到指针s指向了'\0',这时候结束

}//所以这个函数其实就是字符串拼接函数,相当于strcat函数

main()

{

char

ss[10]="acc",a[10]="bbxsd";//第二个写错了应该是aa[10]

fun(ss,aa);//调用拼接函数

printf("%s,%s",ss,aa);//输出拼接后的字符串ss和原来的aa字符串

}

C语言基本代码,求详细解释,越详细越好。

这代码的注释已经很详细了呀。前面都是一堆学生信息的声明。从main()开始看,两行*****************之间的代码是你的学生管理系统的主界面及其(增删查改)功能。接下来就是if/else的判断,这是判断你输入的数字是否和你设定好的(增删查改)功能相匹配,如果匹配则可以进行相信的学生信息修改。在你做完一次选择之后,会进行类似与一个返回上级的操作,就是清屏/清除你刚才的选择。那么这个时候,只是除掉你对功能编号的选择,而保留了学生管理系统的主界面及其功能,为什么清屏没有全部清除掉呢?是因为在最初你加了一个while(1)的循环,可以循环回到系统主界面。至于你最后的代码功能cin1(){}这一段是被if/else第一判断调用(n = cin1(); //录入入n个学生的信息)。学生系统一开始是没有录入学生信息的,那么调用这段代码,你会手动将学生信息录入到系统中,这样才能进行其他功能(增删查改)的操作。

(入门级)C语言程序 看不懂,求详细每行注释

15.写出下列程序的运行结果:____3 4______。 main() //C语言主函数 { int n; //定义变量n For(n=3; n=10; n++) //从n=3开始,做一个循环,每次n加1,n10时结束循环 { if(n%5= =0)break; // 如果n除以5余0,就退出for循环 Printf(“%d”,n); } } //打印n16. main() { inta=10,b=4,c=3; 定义a,b,c并赋予初始值 if (ab) a=b; a小于b,就把b值赋予a if (ac) a=c; a小于c就把c值赋予a printf(“%d,%d,%d”,a,b,c);} 打印a,b,c新的值运行结果为:____10,4,3___________。17. main( ){ int y=9; 定义整型变量y,并赋予初值9, for (;y0;y--) 循环开始,每次循环y减1,到y=0时结束 if (y%3= = 0){printf (“%d”,--y);continue;} 如果y除以3余数为零,y先自减1,之后打印y,接着进入下次循环运行结果为:_____8 5 2___________。 18. main(){ int x,y; 定义整型变量x,y for (y=1,x=1;y=50;y++) 初始值y=1,x=1,开始循环,每次循环结束y加1,y50结束循环

{ if (x=10) break; 如果x=10结束循环 if (x%2= =1) { x+=5;continue;} 如果x除以2余1,x自加5,继续下次循环 x-=3; } x自减3 printf (“%d”,y);} 打印y运行结果为:_____1 2 3 4 5 ___________。 19. main(){ static inta[][3]={9,7,5,3,1,2,4,6,8}; 定义局部静态整型二维数组a,第二维长度为3,并赋予初始值 inti,j,s1=0,s2=0; 定义整形变量i,j,s1,s2,赋予s1,s2初始值0 for (i=0;i3;i++) 外层for循环3次,循环变量为i for (j=0;j3;j++) 内层for循环3次,循环变量为y { if (i= =j )s1=s1+a[i][j]; 如果i=j,就把数组中a[i][j]元素的值加入s1,

if (i+j= =2) s2=s2+a[i][j]; 如果i+j==2,就把数组中a[i][j]元素的值加入s2

} printf (“%d\n%d\n”,s1,s2);} 打印s1,s2运行结果为:18

10____________。20. intfac(int n) 定义返回整型数的fac函数,参数为整型数n {static int f=1; 定义静态整型数f,并赋予初始值1 f=f*n; return(f);} 计算f和参数n的乘积并赋予f,返回fmain(){int i; 定义整型变量i for (i=1;i=5;i++) 从i=1开始,循环5次,每次循环后i自加1 printf (“%d!=%d\n”,i,fac(i));} 运行结果为:1!=1

2!=2

3!=6

4!=24

5!=120___。

求C语言代码,最好有注释。

【例】把一个整数按大小顺序插入已排好序的数组中。

为了把一个数按大小插入已排好序的数组中,应首先确定排序是从大到小还是从小到大进行的。设排序是从大到小进序的,则可把欲插入的数与数组中各数逐个比较,当找到第一个比插入数小的元素i时,该元素之前即为插入位置。然后从数组最后一个元素开始到该元素为止,逐个后移一个单元。最后把插入数赋予元素i即可。如果被插入数比所有的元素值都小则插入最后位置。

main()

{

??int?i,j,p,q,s,n,a[11]={127,3,6,28,54,68,87,105,162,18};

??for(i=0;i10;i++)

??????{?p=i;q=a[i];

?for(j=i+1;j10;j++)

?if(qa[j])?{p=j;q=a[j];}

?if(p!=i)

?{

???s=a[i];

???a[i]=a[p];

???a[p]=s;

?}

?printf("%d?",a[i]);

??????}

????printf("\ninput?number:\n");

????scanf("%d",n);

????for(i=0;i10;i++)

??????if(na[i])

??????{for(s=9;s=i;s--)?a[s+1]=a[s];

??????break;}

??????a[i]=n;

????for(i=0;i=10;i++)

??????printf("%d?",a[i]);

????printf("\n");

}

?

本程序首先对数组a中的10个数从大到小排序并输出排序结果。然后输入要插入的整数n。再用一个for语句把n和数组元素逐个比较,如果发现有na[i]时,则由一个内循环把i以下各元素值顺次后移一个单元。后移应从后向前进行(从a[9]开始到a[i]为止)。?后移结束跳出外循环。插入点为i,把n赋予a[i]即可。?如所有的元素均大于被插入数,则并未进行过后移工作。此时i=10,结果是把n赋于a[10]。最后一个循环输出插入数后的数组各元素值。

????程序运行时,输入数47。从结果中可以看出47已插入到54和?28之间。

(责任编辑:IT教学网)

更多