锐客网

  1. 首页 > 生活百科 > it技术 > >

c语言函数注释包含 c语言函数注释包含哪些类型

IT技术注释

c语言中注释的位置1、可以使用/*和*/分隔符来标注一行内的注释 ， 也可以标注多行的注释 。例如，在下列的函数原型中，省略号的意思是 open() 函数有第三个参数，它是可选参数 。注释解释了这个可选参数的用法：
int open( const char *name, int mode, … /* int permissions */ );
2、可以使用//插入整行的注释，或者将源代码写成两列分栏的格式，程序在左列 ， 注释在右列：
const double pi = 3.1415926536;// pi是—个常量
扩展资料
在 C99 标准中，单行注释正式加入C语言，但是大部分编译器在 C99 之前就已经开始支持这种用法 。有时候，其被称作“C风格”的注释，但实际上 ， 其源自于C的前身 BCPL 。
1、在引号中，如果采用/*或//分隔一个字符常量或字符串字面量（string literal），它们都不会被视为注释的开始 。例如，下面语句就没有注释：
printf("Comments in C begin with /* or //.\n" );
2、预处理器仅通过检查注释的结束符来检测注释中的字符，因此 ， 不能嵌套块注释 。然而，可以使用/*和*/注释包含单行注释的源代码：
/* 暂时注释掉这两行：
const double pi = 3.1415926536;// pi是一个常量
area = pi * r * r;// 计算面积
暂时注释到此 */
C语言编程的注释符号有哪几种？有两种注释方法：
// 行注释，可以注释其后c语言函数注释包含的一行 。
/* */ 块注释，注释这两个符号中间的所有区域 。
【释的原则】
注释的目的是解释代码的目的、功能和采用的方法 ， 提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息 。示例：如下注释意义不大 。
/* if receive_flag is TRUE */
if (receive_flag)
而如下的注释则给出c语言函数注释包含了额外有用的信息 。
/* if mtp receive a message from links */
if (receive_flag)
【说明性文件头部应进行注释】
说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等)头部应进行注释 ， 注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明 。
示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内 。
【源文件头部应进行注释】
源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等 。
示例：下面这段源文件的头注释比较标准，当然 ， 并不局限于此格式，但上述信息建议要包含在内 。
【函数头部应进行注释】
函数头部应进行注释，列出：函数的目的/ 功能、输入参数、输出参数、返回值、调用关系(函数、表)等 。
示例1：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内 。
C语言程序注释C语言编程规范-注释
规则:
1c语言函数注释包含：一般情况下c语言函数注释包含 ， 源程序有效注释量必须在20％以上 。
说明c语言函数注释包含：注释c语言函数注释包含的原则是有助于对程序的阅读理解，在该加的地方都加c语言函数注释包含了，注释不宜太多也不能太少 ， 注释语言必须准确、易懂、简洁 。
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:// 历史修改记录
authortimeversiondesc
David96/10/121.0build 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 */
enumSCCP_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 － SUCCESS1 － GT Table error */
/* 2 － GT errorOthers － no use*/// 变量取值范围
/* onlyfunctionSCCPTranslate() in */
/* this modual can modify it,andother */
/* module can visit it through call */
/* thefunction 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 (indexMAX_INDEX)
{
// program code
} /* end of while (indexMAX_INDEX) */ // 指明该条while语句结束
} /* end ofif (...)*/ // 指明是哪条if语句结束
5：注释格式尽量统一，建议使用"/* …… */" 。
6：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文 ， 除非能用非常流利准确的英文表达 。
说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文 。
【c语言函数注释包含 c语言函数注释包含哪些类型】关于c语言函数注释包含和c语言函数注释包含哪些类型的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息 ， 记得收藏关注本站 。

    推荐阅读


    上一篇：c语言中如何查询字库，c语言怎么查找字符串

    下一篇：腾讯直播带货的方法和技巧，腾讯直播怎么卖货