see格式如下: @see 简要参考内容 deprecated:指定函数过时指令操作符。 deprecated格式如下: @deprecated 简要说明 调试Bug说明 解决的bug说明,@bug 警告说明 (warning) 定义一些关于这个函数必须知道的事情,@warning 备注说明 (remarks) 定义一些关于这个函数的备注信息,@remarks 将要完成的工作 (todo) 说明哪些事情...
deprecated格式如下: @deprecated 简要说明 调试Bug说明 解决的bug说明,@bug 警告说明 (warning) 定义一些关于这个函数必须知道的事情,@warning 备注说明 (remarks) 定义一些关于这个函数的备注信息,@remarks 将要完成的工作 (todo) 说明哪些事情将在不久以后完成,@todo 使用例子说明 (example) 例子说明,@example exa...
see格式如下: @see 简要参考内容 deprecated:指定函数过时指令操作符。 deprecated格式如下: @deprecated 简要说明 调试Bug说明 解决的bug说明,@bug 警告说明 (warning) 定义一些关于这个函数必须知道的事情,@warning 备注说明 (remarks) 定义一些关于这个函数的备注信息,@remarks 将要完成的工作 (todo) 说明哪些事情...
每一个函数名前缀需包含模块名,模块名为小写,与函数名区别开。 如:uartReceive(串口接收) 备注:对于非常简单的程序,可以不加模块名。 2、函数的的形参需另启一行,在后面给予说明,形参都以下划线_开头,已示与普通变量进行区分,对于没有形参为空的函数(void)括号紧跟函数后面。 /*** * 函数名:uartConvUartBaud...
一些自动文档工具定义的属性可以包含在文档中,常用的有: n 前提条件 (pre) 定义调用这个函数的前提条件 n 警告说明 (warning) 定义一些关于这个函数必须知道的事情。 n 备注说明 (remarks) 定义一些关于这个函数的备注信息。 n 将要完成的工作 (todo) 说明哪些事情将在不久以后完成...
3.3函数注释 3.3.1函数头部注释 函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容。如有必要还可增加作者、创建日期、修改记录(备注)等相关项目。 函数头部注释放在每个函数的顶端,用"/*……*/"的格式包含。其中函数名称应简写为Name(),不加入、出口参数等信息。 /*** 函数名称: 函数功能: 入口...
函数名称: 函数功能: 入口参数: 出口参数: 备注: ***/ 3.3.2 代码注释 代码注释应与被注释的代码紧邻,放在其上方或右方,不可放在下面。如放于上方则需与其上面的代码用空行隔开。一般少量注释应该添加在被注释语句的行尾,一个函数内的多个注释左对齐;较多注释则应加在上方且注释行与被注释的语句左对齐。 函...
应确保每个函数声明中的参数的名称、类型和定义中的名称、类型一致。 5 函数参数命名规范 (1)参数名称的命名参照变量命名规范。 (2)为了提高程序的运行效率,减少参数占用的堆栈,传递大结构的参数,一律采用指针或引用方式传递。 (3)为了便于其他程序员识别某个指针参数是入口参数还是出口参数,同时便于编译器检查错误,...
1.7.4 函数指针与块函数(Block Objects) 对于函数指针与块函数,也可参考“方法的注释”写多行注释。例如—— /** * @brief 动作回调函数. * * @param sender 发送者. * @param userdata 自定义数据.*/typedefvoid(*ActionCallback)(void* sender,void*userdata);/** ...
对非通用的变量,在定义时加入注释说明,变量定义尽量可能放在函数的开始处。 见下表: 变量类型 前缀 实例 备注 位域 bit bitRXEN 寄存器控制接收使能的位 Bool b bTurnOn Unsigned Char uc ucError Char c cName Unsigned Short w wMsg Short n nCnt Unsigned Int u uiLen Int i iVal Unsigned Long ul ul...