函数头部注释 函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。 /** * Function: // 函数名称 * Description: // 函数功能、性能等的描述 * Calls: // 被本函数调用的函数清单 * Called By: // 调用本函数的函数清单 * Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操...
以下是常用的C语言函数注释格式: 1.函数名称:用于说明函数的名称和功能。例如:“/*函数名称:add_nums添加两个数的和*/” 2.参数列表:用于列出函数的参数及其作用。例如:“/*参数列表:num1 -第一个数字,num2 -第二个数字*/” 3.返回值:用于描述函数的返回值类型及其含义。例如:“/*返回值:返回两个数字...
可能一个变量、一个函数包含的意思非常复杂,需要多个单词拼写而成,此时对拼写内容就需要详细注释。 2.说明 注释的通常写法是包含正确大小写和结尾句号的完整叙述性语句. 大多数情况下, 完整的句子比句子片段可读性更高. 短一点的注释, 比如代码行尾注释, 可以随意点, 但依然要...
以下是一些可以遵循的C代码工程注释规范: 1 文件头注释 每个源文件的开头都应该有一份注释,用于描述文件的用途、作者、创建日期和版本等信息。例如: /* * File: example.c * Author: Abin * Date: 2023-03-01 * Description: This file contains an example of C code. * Version: 1.0 */ 2 函数头...
* 注释本体 */intmyFrameSize; 如果是函数,尽量在注释本体说明 函数功能、输入、输出含义,如: /** * Allocate an AVAudioFifo. * *@paramsample_fmt sample format *@paramchannels number of channels *@paramnb_samples initial allocation size, in samples ...
1.注释原则 项目开发中,尽量保持代码注释规范和统一。 注释方便了代码的阅读和维护。 边写代码边注释,修改代码时要相应修改注释,保证注释和代码的一致性。 注释要简洁明确,不要出现形容词。 通过注释可以快速知道所写函数的功能,返回值,参数的使用。 2.文件头部注释 ...
本文将介绍C语言函数头注释的基本结构和编写规范。 1. 函数头注释的基本结构 函数头注释通常由三个部分组成:函数说明、参数说明和返回值说明。下面是一个函数头注释的示例: /***函数说明*** 函数名称:open_file 函数功能:打开文件并返回文件句柄 输入参数:filename - 要打开的文件名 mode - 打开文件的模式(只...
双斜杠注释符常用于内容较短的描述,斜杠星多用于内容较多的描述。 上面代码中 main函数最先被执行,之后main函数 { } 里面的内容开始顺序执行,这里要记住是顺序执行,上面代码中main函数体(大括号)内顺序执行的步骤如下: Step 1: int v = 5; //声明了一个变量v 类型是整数类型 , 然后把 5 赋值 给 变量v...
1、C语言初学者编程规范一注释1注释的原则和目的注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的一一清晰准确的函数、变量等的命名,可增加代码可读性,并...
函数注释 1、总述 函数声明处的注释描述函数功能; 定义处的注释描述函数实现。2、说明函数声明:基本上每个函数声明处前都应当加上注释, 描述函数的功能和用途. 只有在函数的功能简单而明显时才能省略这些注释(例如, 简单的取值和设值函数)。比如:FreeRTOS创建任务函数声明: ...