C语言程序解释
有两种注释方法:
// 行注释,可以注释其后的一行。
/* */ 块注释,注释这两个符号中间的所有区域。
【释的原则】
注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。 示例:如下注释意义不大。
/* if receive_flag is TRUE */
if (receive_flag)
而如下的注释则给出了额外有用的信息。
/* if mtp receive a message from links */
if (receive_flag)
【说明性文件头部应进行注释】
说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
【源文件头部应进行注释】
源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
【函数头部应进行注释】
函数头部应进行注释,列出:函数的目的/ 功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
示例1:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
你是拿诺基亚照的么,像素低的,我们看啥
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:注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。
说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。
希望对你能有所帮助。
解释程序的功能是
解释程序的功能是:解释执行高级语言程序 解释程序是一种特殊的计算机程序,它的主要功能是将高级语言程序翻译成可执行的机器语言程序。与编译器不同,解释程序并不将整个程序一次性翻译成机器语言,而是逐条语句地解释执行源程序。当解释程序遇到一条语句时,它会将该语句翻译成机器语言并执行。这种解释执行...
什么是解释程序啊
源程序和高级语言程序是一个概念 简单说就解释程序把你的高级语言代码 解释成 机器认识的二进制代码 比如这种形式 A、解释程序 所谓解释程序是高级语言翻译程序的一种,它将源语言(如BASIC)书写的源程序作为输入,解释一句后就提交计算机执行一句,并不形成目标程序。就像外语翻译中的“口译”一样,说一句...
单片机(c语言)程序解释?
while(1); \/\/循环,整个程序交由定时中断控制。} \/\/此处为定时器中断子程序,每次定时器溢出,进入此段程序。\/\/根据参数定义,每5ms中断一次。\/\/定时器中断后,计数不停止,但是需要重新初始化定时\/计数器。void t0(void) interrupt 1 using 0 { \/\/重新“初始化定时\/计数器”高、低字节。TH0...
c语言 这个程序怎么解释
(unsigned long) p + 0x1 = 0x100001 p的值是一个地址值为0x100000,(unsigned long)p把p转换为一个无符号长整形数值,其加1之后,就是0x100001 (unsigned int*) p + 0x1 = 0x100004 p的值是一个地址值为0x100000,(unsigned int*) p把p转换为无符号长整形的指针,而c\/c++语言中,一...
c语言程序帮忙解释一下小程序 疑问在加粗部分 详细一些 从c基础上解 ...
就是换行 f1=f1+f2; f1和f2是两个定义了的变量,赋值的方向是从右向左,不像数学运算的1+1=2是从左向右 即先把f1和f2变量的值(刚才赋值了)相加,再把结果赋值给f1,覆盖了原来的值 再一次f1=f1+f2;同样道理。。。至于为什么再加这一句,就看设计这程序想要干什么 ...
C语言程序~翻译下解释下每行的意思~谢谢了
include<stdio.h> \/\/由于下面程序会用到scanf和printf语句,所以需要包含这个头文件 int main() \/\/主函数的返回值为整型,这要求程序有return 0;这样的返回语句 { int a[10]; \/\/定义10个单元的数组,数组名为a,10个元素分别是:a[0],a[1],...,a[9]int i,j,t; \/\/定义工作变量 print...
解释一小段 C 语言程序
tp++ = *fp++; \/\/*tp++ = *fp++ 意为:将*fp++指向的内容赋给tp++;\/\/(char *)mp->s意为:先将mp转换为char开指针,再指向s,再用tp指向mp;\/\/tp < (char *)(mp+1)意为:tp里面的内容小于mp+1所指向的内容时则结束循环;参考资料:c语言,谭浩强 编 ...
解释程序的功能是
解释程序的功能是解释执行高级语言程序。解释程序由一个总控程序和若干个执行子程序组成。解释程序的工作方式非常适于人通过终端设备与计算机会话,如在终端上打一条命令或语句,解释程序就立即将此语句解释成一条或几条指令并提交硬件立即执行且将执行结果反映到终端,从终端把命令打入后,就能立即得到计算...
编译程序和解释程序都是什么意思?
编译程序以高级程序设计语言书写的源程序作为输入,而以汇编语言或机器语言表示的目标程序作为输出;编译出的目标程序通常还要经历运行阶段,以便在运行程序的支持下运行,加工初始数据,算出所需的计算结果。2、解释程序是高级语言翻译程序的一种,它将源语言书写的源程序作为输入,解释一句后就提交计算机执行...
程序语言是什么?
- 汇编语言源程序必须经过汇编,生成目标文件,然后执行。 2、高级语言 - BASIC(True basic、Qbasic、Virtual Basic)、C、PASCAL、FORTRAN、智能化语言(LISP、Prolog)等等。 - 高级语言源程序可以用解释、编译两种方式执行。通常用后一种。 我们使用的C语言就是使用的后者。 3、专用语言 CAD系统中的...
阿响佳和: C语言是一种计算机程序设计语言.它既有高级语言的特点,又具有汇编语言的特点.它可以作为系统设计语言,编写工作系统应用程序,也可以作为应用程序设计语言,编写不依赖计算机硬件的应用程序.因此,它的应用范围广泛...
延吉市13827308348: C语言程序解释 - ?
阿响佳和: 1 在16编译系统中,如TC中,就是65535;在32位编译系统中,如VC++中,结果就是4294967295. 2 在16位编译系统中,-1的补码为:1111111111111111,其对应的无符号数就是65535.32位编译系统同理.
延吉市13827308348: C语言程序解读 - ?
阿响佳和: 是的.第一个getchar()接收s,让循环开始.然后循环中getchar()接收后面输入的字符,直到输入'\n'也就是回车键结束循环.
延吉市13827308348: C语言程序,求详细解释!! 具体每一步的解释,谢谢~~ - ?
阿响佳和: int i,j,x=0; //定义三个整形变量,赋值为0 for (i=0;i<20;i++) //for循环 i从0开始逐渐加1,循环20次.{x=x+1; //x+1再赋值给x自己 for (j=0;j<3;j++){ //for循环 j从0逐渐加1 ,循环3次.if(j%2) continue; //如果 j取余2 不等于0,也就是if条件为true,就不...
延吉市13827308348: c语言简单程序,解释一下各段意思 - ?
阿响佳和: scanf是输入函数,就是接收两个整数 c=a+b是把输入的连个数的和赋值个变量C printf是输出函数,就是输出刚才收入两个数据的和 getch收入一个字符
延吉市13827308348: C语言程序代码解读 - ?
阿响佳和: 不难理解,整个算法就是:先找p字串开头的空格,全部忽略掉,然后将所有非空字符复制到q,当再次遇到空格时,将所有的空格压缩成一个'_',然后再将所有非空字符复制到q,这样循环直至p字串处理完毕.具体解释如下.while ( *p!='\0' ) { ...
延吉市13827308348: C程序,解释一下 - ?
阿响佳和: c语言中,字符型和整型可以相互转化(二者在某种意义上是一回事),字符-〉整型是求取其ascii码,整型-〉字符型是求其所代表的字符.将'a'的ascii码(一个整数)赋给p,将ascii码为97的字母...
延吉市13827308348: C语言程序是干嘛的?? - ?
阿响佳和: C语言是Combined Language(组合语言)的中英混合简称.这句话头一次听说,不知道作者是从哪看到的,我学编程这么多年,头一次听说C语言是如此定义的,请不要误人子弟.望改正!C语言发展如此迅速,而且成为最受欢迎的语言之...
延吉市13827308348: C语言新手 下面程序一步一步解释下 - ?
阿响佳和: m=a>b,因为5>6为假所以m=0,又因为是&&逻辑与运算,前面为假后面就不执行了,所以n=c>b这个不执行,所以n任然是2不变,请采纳