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) 说明哪些事情...
该文件与具体的芯片型号有关,并且只包含一个芯片初始化函数,若想由编译器自动调用芯片初始化函数,其函数名必须为"_HC08Setup",否则编译器会自动建立并调用一个空的"__HC08Setup"汇编子程序,而不理会用户创建的芯片初始化函数。为了统一,将该函数起名为"MCUInit",并在主函数中调用该函数。 7.2.3 通用函数头文件...
一些自动文档工具定义的属性可以包含在文档中,常用的有: n 前提条件 (pre) 定义调用这个函数的前提条件 n 警告说明 (warning) 定义一些关于这个函数必须知道的事情。 n 备注说明 (remarks) 定义一些关于这个函数的备注信息。 n 将要完成的工作 (todo) 说明哪些事情将在不久以后完成...
函数名称: 函数功能: 入口参数: 出口参数: 备注: ***/ 3.3.2 代码注释 代码注释应与被注释的代码紧邻,放在其上方或右方,不可放在下面。如放于上方则需与其上面的代码用空行隔开。一般少量注释应该添加在被注释语句的行尾,一个函数内的多个注释左对齐;较多注释则应加在上方且注释行与被注释的语句左对齐。 函...
应确保每个函数声明中的参数的名称、类型和定义中的名称、类型一致。 5 函数参数命名规范 (1)参数名称的命名参照变量命名规范。 (2)为了提高程序的运行效率,减少参数占用的堆栈,传递大结构的参数,一律采用指针或引用方式传递。 (3)为了便于其他程序员识别某个指针参数是入口参数还是出口参数,同时便于编译器检查错误,...
对非通用的变量,在定义时加入注释说明,变量定义尽量可能放在函数的开始处。 见下表: 变量类型 前缀 实例 备注 位域 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...
函数实参实参写法函数形参备注int xxint x基本数据类型直接写就行int arr[128]arrint arr[]一维数组传参的时候数组大小是不写的,需要另外传递进去int douArr[3] [4]douArrint douArr[] [4]二维数组传递参数实参直接写数组名,形参省略行号,但是列不能省略 形参名和实参名可以不一样,这里只是作为示例,不是意味...