以下是常用的C语言函数注释格式: 1.函数名称:用于说明函数的名称和功能。例如:“/*函数名称:add_nums添加两个数的和*/” 2.参数列表:用于列出函数的参数及其作用。例如:“/*参数列表:num1 -第一个数字,num2 -第二个数字*/” 3.返回值:用于描述函数的返回值类型及其含义。例如:“/*返回值:返回两个数字...
下面是C语言函数注释的格式: 1.函数名字和注释开始的位置。 /** *函数名字:函数名 *功能:函数的功能描述 * */ 2.参数列表和每个参数的含义。 /** *函数名字:函数名 *功能:函数的功能描述 *参数: *参数1:参数1的含义 *参数2:参数2的含义 * */ 3.函数的返回值和返回值的含义。 /** *函数名字:...
1 文件头注释 每个源文件的开头都应该有一份注释,用于描述文件的用途、作者、创建日期和版本等信息。例如: /* * File: example.c * Author: Abin * Date: 2023-03-01 * Description: This file contains an example of C code. * Version: 1.0 */ 2 函数头注释 每个函数的开头都应该有一份注释,用于...
2.4函数头部应进行注释 函数头部应进行注释,列出:函数的目的/ 功能、输入参数、输出参数、返回值、调用关系(函数、表)等。 示例1:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /** * Function: // 函数名称 * Description: // 函数功能、性能等的描述 * Calls: // 被本...
*@brief函数功能 *@params*@return*@parhistory * xx create @2023-xx-xx */ 微信公众号【嵌入式系统】提示,注释格式可以参考Doxygen标准。 ◎ 全局变量要有较详细的注释 ◎ 函数内部注释:函数内部不是注释越多越好,而是变量命名和逻辑清晰,自注释最好,特殊情况或者需要特别注意的地方才加注释,并且注释要放在代...
下面是一种常用的C语言函数注释格式: /** * 函数名:function_name * 功能:函数的作用 * 参数:(参数类型) 参数名 参数说明 * 返回值:返回值类型 返回值说明 */ 其中,函数名应该是一句话的概括,体现函数的主要功能;功能部分应该对函数的具体功能进行详细描述,包括输入输出等;参数部分应该列出函数的输入参数,...
1、注释 1.1 单行注释 语法:// 待注释的内容 位置:可放在代码后,称之为行尾注释; 也可放代码上一行,称作行上注释。 1.2 多行注释 语法:/* 待注释的内容 */ 注意:多⾏注释内,可以嵌套单⾏注释。 多⾏注释之间不能嵌套。 /*这是多行注释文字这是多行注释文字这是多行注释文字*/注意:多行注释不能...
格式说明符与printf()函数一起使用,告诉编译器变量存储的数据类型。它基本上是变量值的占位符。 格式说明符以百分比符号%开头,后跟一个字符。 例如,要输出一个int变量的值,您必须使用格式说明符%d或%i放在双引号内,并在printf()函数内使用: 代码语言:c ...
Return: // 函数返回值的说明 Others: // 其它说明 ***/ 这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 3. 数据结构声明的注释(包括数组、结构、类、枚举等) 如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方...