欢迎来到天天文库
浏览记录
ID:57276373
大小:75.00 KB
页数:12页
时间:2020-08-08
《嵌入式系统中的C语言编码规范.doc》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、嵌入式系统中的C语言编码规范2004-11范围本文件规定了书写程序代码时的一般规则和要求。本文件适用于研发中心监控硬件室的嵌入式程序开发过程。2原则2.1目的为了统一在项目开发中的程序编码风格,提高代码的编写质量和可重用性,使代码具有如下的特点:可移植性,一致性,易维护性,易理解性,整洁、简朴和清晰。2.2基本原则1)书写的所有C语言代码应遵守ANSIC规范。2)保持代码简洁。3)语言描述直接、清晰。4)风格要保持一致。5)要避免语句复杂。6)慎重使用GOTO语句。7)及时更新旧代码。8)注释要通俗易懂,不产生歧义。3源文件3.1注意代码行的宽度代码行的宽度不
2、可太长,以避免代码在显示器上显示时和被打印出来后的清单不便阅读。较长的语句要分成多行书写,划分出的新行要进行适当的缩进,使排版整齐,语句易读。如果能够做到:“长表达式在低优先级操作符处划分新行,操作符放在新行之首”,就最好。3.2关于制表符(TAB)因为TAB符(ASCII码为0x09)在不同的计算机和打印机上所表现的可能不同,使得维护不便。要使用合适数量的空格符(ASCII码为0x20)代替TAB来对齐文字。3.3使用4个空格的缩进方式程序块要采用缩进风格编写,缩进的空格数为4,缩进只使用空格键,不用TAB键。3.4程序块的分界符程序块的分界符(大括号“{”
3、和“}”)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、结构体的定义、联合体的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。1.1关于文件头和函数头部的注释源文件(包括说明性如:头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应放置注释文字,注释必须列出:版权说明、版本号、完成日期、作者、内容、模块目的/功能、主要函数及其功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。函数头部也应进行注释,注释时要列出:函数名、函数的目的
4、/功能、输入参数、输出参数、返回值、调用关系(函数、表)等(必要时要举例说明函数的使用方法)。1.2文件书写的层次实现文件(.C文件)的层次:FileheadingRevisionhistory#include#defineconstantsMacrosLocaldatatypesLocalvariablesLocaltablesLocalfunctionprototypesGlobalfunctionsLocalfunctions声明文件(.H文件)的层次:FileheadingRevisionhistory#defineconstantsGlobalmac
5、rosGlobaldatatypesGlobalvariablesExternalsGlobalfunctionprototypes1.3用注释将各个主要段分隔使用如下的方式分隔:/********************************************************************************DataTypes*******************************************************************************/typedefunsignedcharBOOL
6、EAN;/********************************************************************************Prototypes*******************************************************************************/BOOLEANTaskRdy(void);空行起着分隔程序段落的作用,空行得体(不过多也不过少)将使程序的布局更加清晰。1.1必须要采取一定的措施防止头文件被重复引用比如在使用HIWARE的HI-CROSS+编译器时
7、可以使用如下的方法:#ifndef_MAIN_H#define_MAIN_HBodyoftheheaderfile.#endif1.2使用#include用#include〈filename.h〉格式来引用标准库的头文件(编译器将从标准库目录开始搜索),用#include“filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。2注释2.1原则上使用中文注释。2.2使每行注释都有其价值一般情况下,源程序有效注释量必须在20%以上。写注释时要明智些!如果一段代码的逻辑关系很复杂,注解将有助于别人理解代码的意图。但如果逻辑关系直线向前
8、,避免加上并非必须的注解。注释使用的语
此文档下载收益归作者所有