MMI开发细则.docVIP

MMI开发细则（版本1.0） 一、概述 1 二、命名规则 1 2.1命名所用字符规则 1 2.2文件命名规则 1 2.3函数命名规则 1 2.4类型的命名规则 2 2.5宏定义的命名规则 2 2.6变量名的命名规则 2 三、注释的编写规则 3 四、文件书写规范 5 五、函数编写规范 5 六、数据类型编写规范 6 七、条件、循环、switch语句编写规范 6 八、其他 7 附录： 9 一、环境设置： 9 二、公共约定及注意事项： 9  一、概述 MMI软件编码主要考虑以下原则： 软件系统的模块化设计原则 软件系统的稳定性、易读性、可修改性、可扩充性和可重用性 本规范中所指的编程是指根据SDL流程图或其它流程图，通过人工方式用高级语言如C语言来实现该流程图的过程。 本规范在充分遵循以上原则的基础之上，定义了在编程过程中文件的命名规则，程序的编排格式、函数名、类型、宏、变量的命名规则、注释的书写规范和C语言的编码规则。 二、命名规则 2.1命名所用字符规则 变量、函数、宏命名只能由26个字母，10个数字，及下划线的一个子集来组成，不能使用“$”等符号。 下划线符号‘_’不能出现在符号名头或结尾，因为这类符号名不够醒目，容易与不带下划线‘_’的符号名混淆。 一个符号名中间不应出现连续两个‘_’，因为两个‘_’与一个‘_’之间的区别不明显，容易混淆。 2.2文件命名规则 MMI软件分为若干任务，每个任务由项目经理给出一个英文缩写。该任务下的所有文件都放在以该缩写为名字的目录中。所有VSS中的文件都必须按照这种路径存放，禁止擅自在VSS中创建或移动目录。 文件命名考虑到与MSDOS等老的文件系统兼容，统一采用符合8.3格式的文件命名格式。 在此基础上规定，任务所属的源文件应命名为YYYYXXXX.C，其中YYYY为任务缩写名（如AFCK）；XXXX为1~4个字符（可有下划线），说明该文件完成的大体功能。任务主函数所在文件为YYYYMAIN.C（如：AFSHMAIN.C）。头文件命名为YYYYXXXX.H。 2.3函数命名规则 函数命名采用大小写字母结合的形式。 函数名中不同意义字段之间不要用下划线连接，而要把每个字段的首字母大写以示区分。 任务入口函数命名在名字最后加上Task。 专有名词和缩写按照习惯的大小写形式嵌入函数名中，不受第一条的限制。 函数命名力求清晰，明了。通过函数名，就能够判断函数的主要处理功能。 【】 LapdSendRRF 【】 LapdA 函数名的长度必须控制在30字符之内。 2.4类型的命名规则 结构，联合，枚举类型定义统一使用typedef struct StructTypeNameTag {…} StructTypeName 的形式，即结构名采用大小写结合的方法。 【】 typedef struct LapdErrorMsgTag{ BYTE ErrorNo; CHAR ErrorMsg[ MAX_LAPD_ERROR_MSG_LEN ]; } LapdErrorMsg; 定义结构、联合、枚举的指针类型在类型名之前再加上P，即采用PTLapdErrorMsg的形式。 2.5宏定义的命名规则 宏定义统一使用大写字母和数字，中间可以加下划线。 宏定义长度不能超过40个字符。 常量定义中如果包含表达式，表达式需用小括号括起来。 2.6变量名的命名规则 对于全局变量，要把本模块使用的所有全局变量都用一个结构封装起来，结构的名字建议采用本模块的英文缩写后面加上Var的形式。如性能测量的英文缩写为measure，则该模块的全局变量都封装在tMeasureVar结构中。结构内部各成员的命名和局部变量的命名规则相同。所有的全局调试开关都用另一个结构封装起来，建议采用Opt作为后缀。 变量名采用类似于匈牙利命名法的方法：变量名最前有类型前缀，类型前缀后面是变量的含义。变量含义采用大小写结合的办法。结构中的变量定义可不加类型前缀。 基本类型前缀定义如下(全部小写)： 基本类型 意义 b Boolean 布尔 by Byte 字节 ch Char 字符 w 无符号16位整型 dw 无符号32位整型 sw 带符号的16位整数 sdw 带符号的32位整数 sz 以PNULL终结的字符 t 自定义类型 基本类型前缀之前可以按需要加上以下的公共前后缀。 公共前后缀 意义 a（前缀） 数组 _p （后缀） 指针 三、注释的编写规则 注释要占到程序量的20%。 每行注释不能超过80列。 注释统一采用中文。 注释统一使用标准C的/**/。不允许采用C++的//。 每个.c文件前必须加上程序前的注释。注释采用统一格式如下。 /