UFQP2-09QI003 VC程序编程规范

文件编号:UF/QP/2-09/QI/003修改:SEPG审核:SEPG日期:01/10/25版号:1.0draft页号:3/31PAGEPAGE12024VC程序编程规范 考虑到易操作性，现将规范尽量与我们现有的习惯结合起来。公司ISO9002规范：（本规范必须遵守）软件著作权:北京用友软件集团有限公司系统名称:ufo(或财务分析等)(例子)功能说明:简要说明本程序的功能相关文档:相关详细设计文档号变量命名及函数的约定变量名约定是用小写字母表示的数据类型标识符作为变量前缀，变量名的词首字符应大写，用汉语拼音时，要在前缀后加下划线符号，词汇之间也加下划线符号。如：preGlobalVariable //英语词汇pre为前缀，GlobalVariable为变量名称。pre_Quanju_BianLiang //汉语拼音 对于是类中的成变量，在上述的约定的变量形式前加上m_，如m_preGlobalVariable 函数名词首字符应大写，如果是汉语拼音则词汇之间用下划线连接，如：CmyClass::FunctionName() //英语词汇CmyClass::HanShu_MingCheng()//汉语拼音类成员前缀：m_preVariablem:代表类成员pre:如前所述的前缀Variable:变量名全局变量前缀：g_preVariableg:代表全局变量pre:如前所述的前缀Variable:变量名 注：尽量使用英语词汇做变量和函数名在一个变量和函数名不可把拼音和英语同用。 用拼音时要有易拼懂性。 前缀所表示的意义见附表。常量及宏定义约定常量及宏定义全部用大写字母如果是英语词汇则词汇之间用下划线，如果是拼音则每个字的拼音之间用下划线，如：constint MAX_LINE=100; //英语#define MAX_LINE100 //英语constint ZUI_DA_HANG=100; //拼音#define ZUI_DA_HANG100 //拼音程序注释的约定规则：（必须遵守）1、对于程序自己生成的注释代码，//TODO行在完成此段代码后必须删除。 其他注释行不可删除。 2、要使用中文。 3、在函数体内的注释尽量不使用/*注释*/形式 4、在一个函数调试完成后，经整理不可有无用的注释。 5、注释不可过多也不可过少。有如下建议：1)、核心模块或有一定算法的代码2）、理解时有一定困难的代码3）、程序框图中有分支之处4）、类成员以及类方法5）、全局变量、全局函数和重要函数 6、函数体前的注释格式：（头文件中函数的声明处不用加任何注释） 对于一些重要的函数和全局函数//******************************************************//* 完成功能：简述函数或过程的功能 *//*调用格式：必要时可举例说明(可选的) *//*参数：列出主要的、不易理解的参数含义和取值范围 *//*返回：返回值含义 *//*对全局变量的影响和其他环境的影响（可选） *//*调用本函数的注意事项（可选） *//* 其他(包括内部变量、算法、参考设计书某页)(可选) *//*******************************************************程序书写规范为了便于代码的修改和重利用，我们的代码应有较好的可读性，应注意以下几方面：1）、变量命名遵循上面的规范。2）、变量的使用应尽量精简。3）、在一函数中变量定义应尽量集中。4）、算法应尽量精练，对某算法补遗时，最好重写算法。5)、要有段落感，该空一行的要空一行，不该空的不空。6)、尽量不使用goto语句。 举例voidCMyClass::Example(intpara1,intpara2,WORDpara3) //前面不可有任何空格{//第一对括号前面不可有任何空格 int iLoop; //以TAB键开始第一行 for(iLoop=0;iLoop<100;iLoop++){ CStringstrTemp; //对于每对括号内的语句用TAB键缩进} //此括号必须与相对的括号的所在行的起始位置对齐if(para1==1){ //不可用空格speace键做缩进格式}elseif(para1==2){}}//非条件语句时每对括号的垂直位置一致。附表必须遵守的前缀规范：基本类型意义bBoolean布尔chChar字符dwDoubleWord双字lLong长型fn Function函数lLong长型iInteger整形p或lp指针pt Cpointstr Cstringrc Crect v 其它变量（在不执行下述表的类型情况下） c 其它类对象（在不执行下述表的类型情况下）以下为参照执行：前缀表示的Windows中常用的基本类型表基本类型意义byByte字节fon(fn)Font字体msgMessage消息re(rc)Rectangle矩形sString串scrScreenregion屏幕区szNULL终正串uUnsignedinteger无符号整数wWord字wndWindows窗口常用的公共前缀前缀意义a数组e数组元素h句柄I数组元素索引MFC中常用基本类(或结构)的前缀前