注册 登录  
 加关注
   显示下一条  |  关闭
温馨提示!由于新浪微博认证机制调整,您的新浪微博帐号绑定已过期,请重新绑定!立即重新绑定新浪微博》  |  关闭

易拉罐的博客

心静自然凉

 
 
 

日志

 
 

嵌入式C语言编程规范  

2011-11-22 20:51:24|  分类: 嵌入式系统 |  标签: |举报 |字号 订阅

  下载LOFTER 我的照片书  |

1引言
1.1编写目的
汇编语言和C语言是开发嵌入式系统软件的两大主要开发语言,尽管汇编代码有着不可替代和比拟的高效率,但是C语言使用的更为普遍,在关键部分可以使用汇编和C代码混合编程。这里我主要说说C语言编程,并且是在嵌入式系统中的C语言编程规范问题。一个稳定的嵌入式系统,除很好的硬件设计,还要有很健壮或者说“安全”的程序。而这些健壮、安全的代码除了程序员本身的能力外,和一个好的编程习惯有很大关系。其实写程序就像是在做一件精细的艺术品。
技术是开方的、延续的,也是共享的。作为程序载体的代码则是传递的介质之一,建立一个相对统一的编程规范,对于实现代码的安全、健壮、延续、共享有着重要作用。
1.2缩写和术语
标识符:指C中的一个变量、常量、函数或类型。在本文档中它与“名称”同义。
定义:变量或常量的定义是指编译器为其分配的内存。函数的定义是指函数体的实现。
声明:指一些实体对编译器的声明所在的位置,如函数原型、类型(由typedef定义)、变量和常量。
宏:指由#define语句定义的代替一个文本串的名字。当该名字在源程序中出现时,预处理器用对应文本串代替它。
固有数据类型(或预定义或基本数据类型):由语言本身定义的数据类型,如int。
用户定义数据类型: 编程人员用struct、union、enum或typedef定义的数据类型。
范围:标识符的范围是指其可见的环境。环境在这里指可以使用该标识符的函数或程序块。
全局:使用范围没有限制。
文件级局部:使用范围局限在一个文件中。
函数级局部:使用范围局限在一个函数中。
头文件:C程序中用于保存程序的声明的文件称为头文件;头文件以".h "为后缀。
源文件:C程序中用于保存程序的实现的文件称为源文件,源文件以".c "为后缀。

 

2 文件组织
2.1 头文件的结构
规则2.1.1:头文件中的不同类型声明按照以下顺序排列:
公司名称(英文);
文件注释(包括文件名称、功能、版本、编写日期、说明和修改历史);
头文件保护开头(#ifndef 文件名_H #define 文件名_H,此处的文件名不含扩展名,并且是大写);
包含文件声明;
宏和常量定义;
类型定义;
全局变量声明;
外部函数原型声明;
头文件保护结尾(#endif);
头文件结束(即在头文件尾加一回车);

2.2 源文件的结构
规则2.2.1:源文件按照以下顺序组织:
公司名称(英文);
文件注释(包括文件名称、功能、版本、编写日期、说明和修改历史);
包含文件声明;
局部宏定义;
全局变量定义/初始化;
局部常数和类型定义;
局部函数原型声明;
函数实现;
源文件结束;

2.3 目录结构
规则2.3.1:头文件和源文件分别保存于不同的目录。

2.4 其他
规则2.4.1:要隔离出依赖于机器硬件的代码(DSP为提高效率,采用处理器提供的专用指令除外)。
规则2.4.2:将组成某个软件包的一个或多个源文件的接口声明单独放在一个头文件中。对于接口头文件中已经定义的内容(函数声明、宏),子模块内部不再单独定义,而是统一引用接口头文件,防止两者不一致。
建议2.4.3:对于子系统之间的接口,在项目启动时就应该定义好,各子系统统一进行引用。
规则2.4.4:在#i nclude指示中不能明确指定操作系统、或文件绝对路径、或相对于当前工作目录的文件路径。用#i nclude <文件名.扩展名>代替#i nclude “文件名.扩展名”;符号<>指示预处理程序到预定义的缺省目录下寻找文件,该路径通常在INCLUDE环境变量中指定的。符号“ ”指示预处理程序先到当前目录下寻找文件,再到预定义的缺省路径下寻找文件。

 


http://blog.21ic.com/user1/5566/archives/2009/55925.html


c语言编程规范和范例

1 排版
1-1:程序块要采用缩进风格编写,缩进的空格数为4个。
1-2:相对独立的程序块之间、变量说明之后必须加空行。
1-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
1-5:若函数或过程中的参数较长,则要进行适当的划分。
1-6:不允许把多个短语句写在一行中,即一行只写一条语句。
1-7:if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
1-8:对齐只使用空格键,不使用TAB键。
说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。
1-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。
1-10:程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
 1-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。
说明:采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C++语言中括号已经是最清晰的标志了。
在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。

 

2 注释
 2-1:一般情况下,源程序有效注释量必须在20%以上。
说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。
 2-2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
2-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
2-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
2-6:注释的内容要清楚、明了,含义准确,防止注释二义性。
说明:错误的注释不但无益反而有害。
规则2-7:避免在注释中使用缩写,特别是非常用缩写。
说明:在使用缩写时或之前,应对缩写进行必要的说明。

2-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
2-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
2-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。
 2-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
2-12:注释与所描述内容进行同样的缩排。
说明:可使程序排版整齐,并方便注释的阅读与理解。
2-13:将注释与其上面的代码用空行隔开。
  2-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。
说明:这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。
2-15:对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。
说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。

3 标识符命名
1    3-1:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。
说明:较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩写;一些单词有大家公认的缩写。
1    3-2:命名中若使用特殊约定或缩写,则要有注释说明。
说明:应该在源文件的开始之处,对文件中所使用的缩写或约定,特别是特殊的缩写,进行必要的注释说明。
1    3-3:自己特有的命名风格,要自始至终保持一致,不可来回变化。
说明:个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可使用。(即命名规则中没有规定到的地方才可有个人命名风格)。
1    3-4:对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。
说明:变量,尤其是局部变量,如果用单个字符表示,很容易敲错(如i写成j),而编译时又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。
1    3-5:命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用UNIX的全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式,用作特殊标识如标识成员变量或全局变量的m_和g_,其后加上大小写混排的方式是允许的。


 

  评论这张
 
阅读(649)| 评论(0)
推荐 转载

历史上的今天

在LOFTER的更多文章

评论

<#--最新日志,群博日志--> <#--推荐日志--> <#--引用记录--> <#--博主推荐--> <#--随机阅读--> <#--首页推荐--> <#--历史上的今天--> <#--被推荐日志--> <#--上一篇,下一篇--> <#-- 热度 --> <#-- 网易新闻广告 --> <#--右边模块结构--> <#--评论模块结构--> <#--引用模块结构--> <#--博主发起的投票-->
 
 
 
 
 
 
 
 
 
 
 
 
 
 

页脚

网易公司版权所有 ©1997-2017