1.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: // 历史修改记录
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:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过。
2.这题c语言注释怎么写
printf("%d\n",a++ + ++b); /*b先自增后与a相加即3+8=11,本行运行后a=4,b=8*/
printf("%d\n",b%a); /*8/4=2余0 所以结果是0 */
printf("%d\n",a/b); /*a/b=0.5由于是整型相除结果还是整型应截掉小数所以a/b=0结果为0*/
printf("%d\n",a+b); /*4+8=12*/
printf("%d\n",a*=b+1); /*相当于a=a*(b+1)=4*9=36*/
3.C语言注释符"\\"
如果注释夹在一百行合法的C语句之间,你把成对的"/**/"改成"//"不就错了吗?
比如下边度的程序:
#include <stdio.h>
int main(void)
{
printf/*输出Hello*/("Hello\n");
}
你改成:回
#include <stdio.h>
int main(void)
{
printf//输出Hello("Hello\n");
}
就错了,但是把答printf分2行写就不会出错,如下:
#include <stdio.h>
int main(void)
{
printf//输出Hello
("Hello\n");
}
4.C语言程序中的注释格式由什么组成
1、少了很多大括号,包括while的,if else的
2、while(feof(fp1)!=EOF) 最好改为while(!feof(fp1))
3、我改后测了一下,这个程序只能删除“/* */”的注释,对“//”的注释无效。再改一下状态机吧。
4、下面的程序我把格式整理了一下,没改什么算法部分。写程序要规范。
#include "stdio.h"
void delcomm(FILE*fp1,FILE*fp2)
{
char c;
int i=0;
while(!feof(fp1))
{
printf("test\n");
if((c=fgetc(fp1))=='\n')
fprintf(fp2,"\n");
else
{
switch(i)
{
case 0:
if (c=='/')
i=1;
else
fprintf(fp2,"%c",c);
break;
case 1:
if (c=='*')
i=2;
else
{
fprintf(fp2,"/%c",c);
i=0;
}
break;
case 2:
if (c=='*')
i=3;
break;
case 3:
i=(c=='/')?0:2;
break;
}
}
}
}
int main()
{
FILE*fp1,*fp2;
if ((fp1=fopen("/home/hxl/test/md5.c","r"))==NULL)
{
printf("wrong!");
exit(0);
}
fp2=fopen("/home/hxl/test/md5out.c","w");
delcomm(fp1,fp2);
fcloseall();
}
5.C语言程序注释
**** C语言写注释:1、可以用任何一种文字2、格式 /* 注释 */3、可放在任何地方**** 好的注释:1、能看懂2、样式统一3、例/*****************************************************主程序*****************************************************/void main(void) **** 还可以采用这些方式1、/* 注释 */2、//注释3、例/*****************************************************///主程序/*****************************************************/void main(void)。
6.C语言程序注释
**** C语言写注释:
1、可以用任何一种文字
2、格式 /* 注释 */
3、可放在任何地方
**** 好的注释:
1、能看懂
2、样式统一
3、例
/*****************************************************
主程序
*****************************************************/
void main(void)
**** 还可以采用这些方式
1、/* 注释 */
2、//注释
3、例
/*****************************************************/
//主程序
/*****************************************************/
void main(void)
7.C程序注释是由什么和什么所界定的文字信息组成的
C程序注释是由 \* 和 *\ 所界定的文字信息组成的。
在编写C语言源代码时,应该多使用注释,这样有助于对代码的理解。在C语言中有两种注释方式:
1、一种是以/*开始、以*/结束的块注释(block comment);
2、另一种是以//开始、以换行符结束的单行注释(line comment)。
可以使用/*和*/分隔符来标注一行内的注释,也可以标注多行的注释。例如,在下列的函数原型中,省略号的意思是 open() 函数有第三个参数,它是可选参数。
扩展资料
C语言注释的作用:写给程序员看的,方便程序员之间的沟通。
1、注释是不参与编译的;
2、多行注释可以嵌套单行注释;
3、单行注释可以嵌套多行注释;
4、多行注释不可以嵌套多行注释。
注释使用的场景:
1、提取代码的时候;
2、调试程序的时候。