三、程序文件注释 头文件注释 说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。 /** * File name: test.h // 文件名 * Author:laubon...
说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应 进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的 关系、修改日志等,头文件的注释中还应有函数功能简要说明。 23、 源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、...
1、1、头文件包含Includes2、私有类型定义 Private typedef3、私有定义Private define4、私有宏定义 Private macro5、私有变量 Private variables6、私有函数原型Private function prototypes7、私有函数Private functions8、私有函数前注释/* Function Name : FSMC_NOR_Init* Description : Configures the FSMC and GPIOs...
1.有效注释量必须在20%以上,注释语言要准确易懂简洁 2.头文件应进行注释,注释必须列出:版本说明、版本号、生成日期、作者、内容、功能、修改日志等。 3.函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。 4.编写代码边注释,修改代码的同时,修改对应的注释,保证注释...
◎ 头文件应当职责单一,头文件过于复杂,依赖过于复杂是导致编译时间过长的主要原因。 ◎ 每一个.c文件应有一个同名.h文件,用于声明需要对外公开的接口。 ◎ 禁止头文件循环依赖,禁止包含用不到的头文件。 ◎ 每个.c源文件内容片段按如下顺序,文件注释-包含头文件-宏定义-数据结构定义-变量定义-引用外部变量-引用...
2)不要在受保护部分的前后放置代码或者注释。 规则1.6 禁止在头文件中定义变量。 说明:在头文件中定义变量,将会由于头文件被其他.c文件包含而导致变量重复定义。 规则1.7 只能通过包含头文件的方式使用其他.c提供的接口,禁止在.c中通过extern的方式使用外部函数接口、变量。
下面就从这几个方面讲解一下嵌入式c编码规范。注释风格、排版风格、头文件风格、变量定义、宏定义、函数 1 注释风格1.1 注释的原则是有助于对程序的阅读和理解,注释不宜太多也不能太少。注释语言必须准确、易懂、简洁,没有歧义性。1.2 程序文件头部代码应进行注释。注释必须列出:版权说明、版本号、生成日期、作者...
1.注释的使用 // 单行注释 /* */多行注释(不能嵌套) #include的使用 include 宏 导入头文件,称为文件包含预处理命令,编译时由预处理器执行 。如果系统已经提供某些功能的实现只需要使用include将这些功能所在的头文件导入进来就可以了。 <系统提供的类库> eg. stdio.h math.h stdlib.h string.h ...
而如下的注释则给出了额外有用的信息。 /* if mtp receive a message from links */ if (receive_flag) 说明性文件头部应进行注释 说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、...