欢迎来到天天文库
浏览记录
ID:59253972
大小:31.18 KB
页数:25页
时间:2020-09-08
《MFC开发编程规范(参考).docx》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、MFC开发编程规范**软件公司软件开发规范 (试行版) 在公司团队协作开发的情况下,编程时应该强调的一个重要方面是程序的易读性,在保证软件的速度等性能指标能满足用户需求的情况下,能让其他程序员容易读懂你的程序。一套鲜明的编程风格,可以让协作者、后继者和自己一目了然,在很短的时间内看清程序的结构,理解设计的思路。大大的提高代码的可读性、可重用性、程序健壮性、可移植性和可维护性。 制定本编程规范的目的是为了提高公司的软件开发效率及所开发的软件的可维护性,提高软件的质量。本规范由程序风格、命名规则、注释
2、规范、程序健壮性、可移植性、错误处理以及软件的模块化规范等部分组成。 一、程序风格: 1、严格采用阶梯层次组织程序代码: 各层次缩进的分格采用VC的缺省风格,即每层次缩进为4格,括号位于下一行。要求相匹配的大括号在同一列,对继行则要求再缩进4格。例如: voidmain() { ...... longlI;//循环变量 longlSum;//用来记录和 floatfAvg;//用来求平均值 ...... //对数进行累加。 for(lI=0;lI<10;lI++) { lSum=lSum+lI;
3、......} //求平均值。 fAvg=lSum/10.0; ...... } 2、提示信息字符串的位置 在程序中需要给出的提示字符串,为了支持多种语言的开发,除了一些给调试用的临时信息外,其他所有的提示信息必须定义在资源中。 3、对变量的定义,尽量位于函数的开始位置。 二、命名规则: 1、变量名的命名规则 ①、变量的命名规则要求用“匈牙利法则”。即开头字母用变量的类型,其余部分用变量的英文意思或其英文意思的缩写,尽量避免用中文的拼音,要求单词的第一个字母应大写。 即:变量名=变量类型+变量的英
4、文意思(或缩写) 对非通用的变量,在定义时加入注释说明,变量定义尽量可能放在函数的开始处。 见下表: bool(BOOL)用b开头bIsParent byte(BYTE)用by开头byFlag short(int)用n开头nStepCount long(LONG)用l开头lSum char(CHAR)用c开头cCount float(FLOAT)用f开头fAvg double(DOUBLE)用d开头dDeta void(VOID)用v开头vVariant unsignedshort(WORD)用w
5、开头wCount unsignedlong(DWORD)用dw开头dwBroad HANDLE(HINSTANCE)用h开头hHandle DWORD用dw开头dwWord LPCSTR(LPCTSTR)用str开头strString 用0结尾的字符串用sz开头szFileName 对未给出的变量类型要求提出并给出命名建议给技术委员会。 ②、指针变量命名的基本原则为: 对一重指针变量的基本原则为: “p”+变量类型前缀+命名 如一个float*型应该表示为pfStat 对多重指针变量的基本规则为:
6、 二重指针:“pp”+变量类型前缀+命名 三重指针:“ppp”+变量类型前缀+命名 ...... ③、全局变量用g_开头,如一个全局的长型变量定义为g_lFailCount,即:变量名=g_+变量类型+变量的英文意思(或缩写) ④、静态变量用s_开头,如一个静态的指针变量定义为s_plPerv_Inst,即:变量名=s_+变量类型+变量的英文意思(或缩写) ⑤、成员变量用m_开头,如一个长型成员变量定义为m_lCount;即:变量名=m_+变量类型+变量的英文意思(或缩写) ⑥、对枚举类型(enu
7、m)中的变量,要求用枚举变量或其缩写做前缀。并且要求用大写。 如:enumcmEMDAYS { EMDAYS_MONDAY; EMDAYS_TUESDAY; …… }; ⑦、对struct、union、class变量的命名要求定义的类型用大写。并要加上前缀,其内部变量的命名规则与变量命名规则一致。 结构一般用S开头 如:structScmNPoint { intnX;//点的X位置 intnY;//点的Y位置 }; 联合体一般用U开头 如:unionUcmLPoint { longlX; long
8、lY; } 类一般用C开头 如: classCcmFPoint { public: floatfPoint; }; 对一般的结构应该定义为类模板,为以后的扩展性考虑 如: template classCcmTVector3d { public: TYPEx,y,z; }; ⑧、对常量(包括错误的编码)命名,要求常量名用大写,常量名用英文表达其意思。 如:#defineCM_FILE_NOT_FOUNDCMMAKEHR(0X20B)其中CM表示类别。 ⑨、对co
此文档下载收益归作者所有