2、函数注释 Function函数名称 Description函数描述 Calls调⽤的函数清单 Input输⼊参数说明，包括每个参数的作⽤、取值说明及参数间关系 Output输出参数的说明 Return函数返回值的说明 Others其他说明 /* * Function:* Description:* Calls:* Input:* Input:* Output:* Return:* Others:*/ 3、宏定义注释 @...
在注释单行的时候特别方便,而且配合/* /注释进行嵌套注释也弥补了 /*/注释不能嵌套的缺点,而最主要的问题是//注释只会影响到单行,不会因为注释不当而引起很多行被注释掉的问题,当然在现在强大的IDE面前,很大注释都有方便的快捷键,一些注释的不方便也就荡然无存了。 四. C语言的函数无参数时是为void还是()?
一、函数注释的格式要求 在C语言中,函数注释通常位于函数声明之前,使用特定的注释格式进行书写。以下是常用的函数注释格式要求: 1. 函数注释以"/**"开始,以"*/"结束,中间的内容为注释的具体描述。 2. 注释的第一行为函数的摘要描述,简明扼要地说明函数的功能。 3. 注释的后续行为详细描述,可以包括函数的参数说...
Input: // 输入参数说明,包括每个参数的作// 用、取值说明及参数间关系。 Output: // 对输出参数的说明。 Return: // 函数返回值的说明 Others: // 其它说明 ***/ 2-4:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。 2-5:注释的内容要清楚、明了,含义...
* Input: // 输入参数说明,包括每个参数的作用 * Output: // 输出参数说明,有时通过指针参数返回一些变量值 * Return: // 函数返回值的说明 * Others: // 其他说明 */ 1.4 对于所有有特定含义的变量、常量、宏、结构体等数据结构,如果其命名不是充分自注释的,在声明时都必须加上注释,说明其实际含义。变量...
函数注释 1.总述 函数声明处的注释描述函数功能; 定义处的注释描述函数实现。 2.说明 函数声明: 基本上每个函数声明处前都应当加上注释, 描述函数的功能和用途. 只有在函数的功能简单而明显时才能省略这些注释(例如, 简单的取值和设值函数)。 比如:FreeRTOS创建任务函数申明: ...
二、函数注释,放于函数声明前 /** * @brief This is a brief description. * @details This is the detail description. * @param[in] inArgName input argument description. * @param[out] outArgName output argument description. * @retval OK 成功 ...
我的C编码风格 首先声明一点,我是一个不相信注释的人,所以我的代码不会有很多注释,我代码的注释越多说明我实现的越蹩脚。我的大部分风格与linux kernel code style保持一致,又增加了一点自己的个人习惯。 1. 所有变量函数名全为小写,单词之间用下画线隔开...
5. 函数注释原则 /** * @brief 函数简要说明-测试函数 * @paramindex参数1 * @param t 参数2@see CTest * * @return 返回说明 * -false fail * -true succeed */ bool Test(intindex, const CTest& t); note:指定函数注意项事或重要的注解指令操作符 note格式如下: @note 简要说明 retval:指定函数...
在C语言中，标准库函数是非常重要的，它们可以使程序更加高效和可移植。建议在代码中使用适当的标准库函数，以完成常见的任务。标准库函数应该使用适当的参数和返回值，以确保程序的正确性和可靠性。总之，C语言编程风格和规范是非常重要的，它们可以提高代码的可读性、可维护性和可重用性，从而提高程序的质量和效率。