嵌入式系统中的C语言编码规范.doc

嵌入式系统中的C语言编码规范
2004-1
范围
本文件规定了书写程序代码时的一般规则和要求。
本文件适用于研发中心监控硬件室的嵌入式程序开发过程。
原则
目的
为了统一在项目开发中的程序编码风格,提高代码的编写质量和可重用性,使代码具有如下的特点:可移植性,一致性,易维护性,易理解性,整洁、简朴和清晰。
基本原则
书写的所有C语言代码应遵守ANSI C规范。
保持代码简洁。
语言描述直接、清晰。
风格要保持一致。
要避免语句复杂。
慎重使用GOTO语句。
及时更新旧代码。
注释要通俗易懂,不产生歧义。
源文件
注意代码行的宽度
代码行的宽度不可太长,以避免代码在显示器上显示时和被打印出来后的清单不便阅读。
较长的语句要分成多行书写,划分出的新行要进行适当的缩进,使排版整齐,语句易读。如果能够做到:“长表达式在低优先级操作符处划分新行,操作符放在新行之首”,就最好。
关于制表符(TAB)
因为TAB符(ASCII码为0x09)在不同的计算机和打印机上所表现的可能不同,使得维护不便。要使用合适数量的空格符(ASCII码为0x20)代替TAB来对齐文字。
使用4个空格的缩进方式
程序块要采用缩进风格编写,缩进的空格数为4,缩进只使用空格键,不用TAB键。
程序块的分界符
程序块的分界符(大括号“{”和“}”)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、结构体的定义、联合体的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
关于文件头和函数头部的注释
源文件(包括说明性如:、.inc文件、.def文件、)头部应放置注释文字,注释必须列出:版权说明、版本号、完成日期、作者、内容、模块目的/功能、主要函数及其功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
函数头部也应进行注释,注释时要列出:函数名、函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等(必要时要举例说明函数的使用方法)。
文件书写的层次
实现文件(.C文件)的层次:
File heading
Revision history
#include
#define constants
Macros
Local data types
Local variables
Local tables
Local function prototypes
Global functions
Local functions
声明文件(.H文件)的层次:
File heading
Revision history
#define constants
Global macros
Global data types
Global variables
Externals
Global function prototypes
用注释将各个主要段分隔
使用如下的方式分隔:
/*
******************************************************************************
* Data Types
******************************************************************************
*/
typedef unsigned char BOOLEAN;
/*
******************************************************************************
* Prototypes
******************************************************************************
*/
BOOLEAN TaskRdy(void);
空行起着分隔程序段落的作用,空行得体(不过多也不过少)将使程序的布局更加清晰。
必须要采取一定的措施防止头文件被重复引用
比如在使用HIWARE的HI-CROSS+编译器时可以使用如下的方法:
#ifndef _MAIN_H
#define _MAIN_H
Body of the header file.
#endif
使用#include
用#include 〈〉格式来引用标准库的头文件(编译器将从标准库目录开始搜索),用#include “”格式来引用非标准库的头文件(编译器将从用户