1 / 7
文档名称:

软件编程规范.doc

格式:doc   大小:29KB   页数:7页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

软件编程规范.doc

上传人:xzh051230 2019/6/10 文件大小:29 KB

下载得到文件列表

软件编程规范.doc

文档介绍

文档介绍:前言为了规范提高代码的质量,加强代码的可维护性,特制定此规范。规范中包含规则和建议,规则是在编程中必须遵守的,建议则是一种提议,可根据具体情况考虑采纳。一、基本数据类型定义规则1-1:为提高代码的可移植性,屏蔽不同系统之间的基本数据类型的长度差异,减少代码在不同系统之间的移植工作量,需要对基本数据类型进行类型声明,基本类型的类型声明标准如下:(两种定义方式进行选择)typedefvoid_VOID;typedefchar_CHAR8;typedefunsignedchar_UCHAR8;typedefsignedchar_SCHAR8;typedefint_INT32;typedefunsignedint_UINT32;typedefsignedint_SINT32;typedefshort_SHORT16;typedefunsignedshort_USHORT16;typedefsignedshort_SSHORT16;typedeflong_LONG32;typedefunsignedlong_ULONG32;typedefsignedlong_SLONG32;typedeffloat_FLOAT32;typedefdouble_DOUBLE64;二、变量与函数命名规则规则2-1:变量类型前缀命名所有变量命名采用匈牙利命名法,数据类型与前缀的定义如下a:array,数组b:bool,布尔by:byte,字节c:char,字符dw:doubleword(unsignedlong),双字fn:function,函数g_:global,全局变量i:integer,整型l:long,长字lp:longpointer,长指针m_:module,模块变量g_:global,全局变量n:shortint,短整型p:pointer,指针s:string,字符串sz:zeroterminatedstring,以零字符结束的字符串u:unsignedint,无符号整型ul:unsignedlong,无符号长整型w:word(unsignedshort),字因为有重复,建议采用红色的前缀。增加三种st:struct,结构en:enum,枚举b<n>:位域变量类型之间可以组合。举例:UINT32*apdwTempPtr[32];UINT32b7Temp:7;规则2-2:变量名称与书写所有变量采用大小写命名方式,单词的首字母大写,其他字母小写,单词与单词之间不采用下划线连接。举例:UCHAR8*pucMyString;规则2-3:模块与全局的区别各模块对外提供的全局变量以g_作为前缀进行表示,模块内部使用的公共变量以m_作为前缀,函数内部的局部变量不使用任何前缀。规则2-4:函数名命名原则函数命名与变量命名一样,采用大小写命名,单词的首字母大写,其他字母小写。单词与单词直接相连,不采用下划线相连。各模块对外提供的接口函数以该模块的缩略语为前缀,中间以下划线相连。各模块的缩略语定义如下:ALM:告警CLI:M:通信DB:数据库DEV:设备管理LD:加载OS:操作系统:TST:测试举例:_VOID*OS_Malloc(_USHORT16wMid,_ULONG32dwSize);规则2-5:宏定义所有宏定义采用大写字母,单词与单词之间以下划线相连。举例:#defineAG_VE