程序编码规范设计

1.1 EA程序源文件命名和管理设计

1、所有模块的源文件名都使用小写字母+下划线_组成。

2、所有的源文件名都以“ea_”开头。

3、模块的源文件至少应包含以下四个文件：

?ea_modulename_types.h：用来放本程序所需的类型、结构、常量的定义。

?ea_modulename_prot.h：用来放本程序所有接口函数和方法函数的声明，此头文件只被本程序的源文件所加载。

?ea_modulename_gprot.h：用来放本程序对外接口函数的声明。

?ea_modulename.c：程序的实现文件。

1.2 程序编码规范设计

1.2.1 排版

1、程序块要采用缩进风格编写，缩进空格数为4个。对齐使用空格，不要使用tab键，

或者将tab键设置为4个空格。

2、独立的程序块之间必须加空行。

3、超过80个字符的语句要分行书写，在低优先级的操作符处分行，操作符位于行首。

4、If、for、do、while、case、switch、default语句要独自占一行。且if、for、do、while

的执行语句不管有多少行都必须加括号{}。

5、程序块的分界符{}，要独自占一行。例如：不要跟在if，for，do，while语句的后

面。

6、对等操作的操作符前后都要加一个空格，如：== ，>= ，<=，+，&&等。

1.2.2 注释

1、注释格式使用“/* … */”，不要使用“//…”。

2、注释语句要写在被描述内容的上面，并且进行同样的缩排。

1.2.3 标识符命名

1、所有标识符采用全小写加下划线的风格。

2、所有类型定义都以“ea_”开头。

3、所有函数名都以“ea_”开头。

4、变量名称以“变量类型_”开头，并遵循以下规则：

?i：代表int型变量。

?l：代表long型变量。

?u：代表unsigned。

?s：代表signed。

?f：代表float。

?d：代表double。

?p：代表指针。

?a：代表数组。

?c：代表char。

?st：代表结构体

?wc：代表wide char。

5、全局变量要以“g_ea_变量类型_变量名”开头

6、所有全局变量的定义必须与Team Leader或者SA进行协商。

例如：

?ea_page_struct *g_ea _stpa _page[10]。是一个全局的结构体指针数组变量，st代表结构体，p代表指针，a代表数组。

?char * cp_filename;

1.2.4 函数、过程

1、尽量不要使用函数的参数作为工作变量。

2、不要使用goto语句。

3、尽量减少函数本身或函数间的递归调用。

4、尽量减少循环嵌套层次。

5、尽量用乘法或其它方法代替除法，特别是浮点运算时。

1.2.5 质量保证

1、仔细使用内存：内存分配和释放要成对出现。

2、防止内存操作越界：这个后果往往非常严重，而且有时很难查错。

3、文件句柄的打开和关闭要成对出现。

4、对程序可能出现的错误要考虑周全，认真处理。

5、严禁随意修改与本模块不相关的或者系统的设置和配置。

6、要注意MTK平台的限制：如堆栈空间大小、数据空间大小、函数名长度等是否超出系

统的有关限制。

7、函数调用层次不要太深，尤其是在使用递归调用函数的时候要考虑MTK平台的栈空间

限制。