Kl25-ch05(构件化开发方法与底层驱动构件封装规范)概述.pptVIP

5.4.2 编码风格基本规范 1．文件、函数、变量、宏及结构体类型的命名规范 命名的基本原则是： （1）命名清晰明了，有明确含义，使用完整单词或约定俗成的缩写。命名中若使用特殊约定或缩写，要有注释说明。 （2）命名风格要自始至终保持一致。 （3）为了代码复用，命名中应避免使用与具体项目相关的前缀。 （4）为了便于管理，对程序实体的命名要体现出所属构件的名称。 （5）使用英语命名。 （6）除宏命名外，名称字符串全部小写，以下划线“_”作为单词的分隔符。首尾字母不用“_”。 针对嵌入式底层驱动构件的设计需要，对文件、函数、 变量、宏及数据结构类型的命令特别进行说明。 1）文件的命名 底层驱动构件在具体设计时分为两个文件，其中头文件命名为“device.h”，源文件命名为“device.c”，其中device表示具体的硬件模块的名称。 2）函数的命名 底层驱动构件的函数从属于驱动构件，驱动函数的命名除要体现函数功能外，还需要使用命名前缀和后缀标识其所属的构件及不同的实现方式。 函数名前缀：底层驱动构件中定义的所有函数均使用“device_”前缀表示其所属的驱动构件模块。 函数名后缀：对同一服务的不同方式的实现，使用后缀加以区分。 3）函数形参变量与函数内局部变量的命名 对嵌入式底层驱动构件进行编码的过程中，需要考虑对底层驱动函数形参变量及驱动函数内部局部变量的命名。 函数形参变量：函数形参变量名是使用函数时理解形参的最直观印象，表示传参的功能说明。 局部变量：局部变量的命名与函数形参变量类似。 4）宏常量及宏函数的命名 宏常量及宏函数的命名全部使用大写字符，使用下划线“_”为分隔符。例如，在构件公共要素中定义的开关中断的宏如下： 5）结构体类型的命名、类型定与变量声明 （1）结构体类型名称使用小写字母命名 （defined_struct_name），定义结构体类型变量时，全部使用大写字母命名（DEFINED_STRUCT_NAME）。 （2）对结构体内部字段全部使用大写字母命名（ ELEM_NAME ）。 （3）定义类型时，同时声明一个结构体变量和结构体指针变量。 模板如下： 2．排版 对程序进行排版是指，通过插入空格与空行，使用缩进、断行等手段，调整代码的书面版式，使代码整体美观、清晰，从而提高代码的可读性。 1）空行与空格 关于空行：相对独立的程序块之间须加空行。 关于空格：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格，必要时加两个空格；进行非对等操作时，如果是关系密切的立即操作符（如－），其后不应加空格。 2）缩进 使用空格缩进，不使用Tab键，这样代码复制打印是不会造成错乱。代码的每一级均往右缩进4个空格的位置。 3）断行 （1）较长的语句（78字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 （2）循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。 （3）若函数或过程中的参数较长，则要进行适当的划分。 （4）不允许把多个短语句写在一行中，即一行只写一条语句。特殊情况可用，例如“if (x3) x=3;”可以在一行。 （5）if、for、do、while、case、switch、default等语句后的程序块分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，且与以上保留字左对齐。 3．注释 在程序代码中使用注释，有助于对程序的阅读理解，说明程序在“做什么”，解释代码的目的、功能和采用的方法。 （1）一般情况源程序有效注释量在30％左右。 （2）注释语言必须准确、易懂、简洁。 （3）编写和修改代码的同时，处理好相应的注释。 （4）C语言中采用“//”注释，不使用段注释“ /* */ ”。段注释