锐客网

  1. 首页 > 睿知 > it技术 > >

c语言函数的注释 c语言中注释的作用是什么

IT技术手上

c语言如何注释？直接在该行需要注释的地方加上"//"即可 。
可以使用/*和*/分隔符来标注一行内的注释，也可以标注多行的注释 。例如 ， 在下列的函数原型中，省略号的意思是 open() 函数有第三个参数，它是可选参数 。
注释解释了这个可选参数的用法：
int open( const char *name, int mode, … /* int permissions */ )；
代码具有较好的可移植性
C语言是面向过程的编程语言 ， 用户只需要关注所被解决问题的本身 ， 而不需要花费过多的精力去了解相关硬件，且针对不同的硬件环境，在用C语言实现相同功能时的代码基本一致，不需或仅需进行少量改动便可完成移植，这就意味着 ， 对于一台计算机编写的C程序可以在另一台计算机上轻松地运行，从而极大的减少了程序移植的工作强度 。
以上内容参考：百度百科-C语言
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.
【c语言函数的注释 c语言中注释的作用是什么】FileName: test.cpp
Author:
Version :
Date:
Description:// 模块描述
Version:// 版本信息
Function List:// 主要函数及其功能
1. -------
History:// 历史修改记录
authortimeversiondesc
David96/10/121.0build this moudle
***********************************************************/
说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等 。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述 。
4：函数头部应进行注释 ， 列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等 。
示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内 。

推荐阅读


上一篇：光算云服务器的性能如何？ 光算云服务器怎么样

下一篇：瑞士区块链牌照价格，瑞士 区块链之都