C++编程风格.doc

在公司团队(Team)协作开发情况下编程时应该强调个重要方面是易读性在保证软件Software速度等性能指标能满足用户需求情况下能让其他员容易读懂你套鲜明编程风格,可以让协作者、后继者和自己目了然在很短时间内看清结构理解设计思路大大提高代码可读性、可重用性、健壮性、可移植性和可维护性 制定本编程规范标准目是为了提高公司软件Software开发效率及所开发软件Software可维护性提高软件Software质量本规范标准由风格、命名规则、注释规范标准、健壮性、可移植性、处理以及软件Software模块化规范标准等部分组成 、风格: 1、严格采用阶梯层次组织代码: 各层次缩进分格采用VC缺省风格即每层次缩进为4格括号位于下行要求相匹配大括号在同列对继行则要求再缩进4格例如: void . longlI;/循环变量 longlSum;/用来记录和 floatfAvg;/用来求平均值 . /对数进行累加 for(lI=0;lI10;lI) lSum=lSum+lI; . /求平均值 fAvg=lSum/10.0; . 2、提示信息串位置 在中需要给出提示串为了支持多种语言开发除了些给调试用临时信息外其他所有提示信息必须定义在资源中 3、对变量定义尽量位于开始位置 2、命名规则: 1、变量名命名规则 、变量命名规则要求用“匈牙利法则”即开头字母用变量类型其余部分用变量英文意思或其英文意思缩写,尽量避免用中文拼音,要求单词第个字母应大写 即:变量名=变量类型+变量英文意思(或缩写) 对非通用变量在定义时加入注释介绍说明变量定义尽量可能放在开始处 见下表: bool(BOOL)用b开头bIsParent (BYTE)用by开头byFlag ()用n开头nStepCount long(LONG)用l开头lSum char(CHAR)用c开头cCount float(FLOAT)用f开头fAvg double(DOUBLE)用d开头dDeta void(VOID)用v开头vVariant unsigned(WORD)用w开头wCount unsignedlong(DWORD)用dw开头dwBroad HANDLE(HINSTANCE)用h开头hHandle DWORD用dw开头dwWord LPCSTR(LPCTSTR)用str开头strString 用0结尾串用sz开头szFileName 对未给出变量类型要求提出并给出命名建议给技术委员会 、指针变量命名基本原则为: 对重指针变量基本原则为: “p”+变量类型前缀+命名 如个float*型应该表示为pfStat 对多重指针变量基本规则为: 2重指针:“pp”+变量类型前缀+命名 3重指针:“ppp”+变量类型前缀+命名 . 、全局变量用g_开头,如个全局长型变量定义为g_lFailCount,即:变量名=g_+变量类型+变量英文意思(或缩写) Page、静态变量用s_开头,如个静态指针变量定义为s_plPerv_Inst,即:变量名=s_+变量类型+变量英文意思(或缩写) 、成员变量用m_开头,如个长型成员变量定义为m_lCount;即:变量名=m_+变量类型+变量英文意思(或缩写) 、对枚举类型(enum)中变量要求用枚举变量或其缩写做前缀并且要求用大写 如:enumcmEMDAYS EMDAYS_MONDAY; EMDAYS_TUESDAY; ; 、对struct、union、变量命名要求定义类型用大写并要加上前缀其内部变量命名规则和变量命名规则致 结构般用S开头 如:structScmNPo nX;/点X位置 nY;/点Y位置 ; 联合体般用U开头 如:unionUcmLPo longlX; longlY; 类般用C开头 如: CcmFPo public: floatfPo; ; 对般结构应该定义为类模板为以后扩展性考虑 如: template CcmTVector3d public: TYPEx,y,z; ; 、对常量(包括编码)命名要求常量名用大写常量名用英文表达其意思 如:#CM_FILE_NOT_FOUNDCMMAKEHR(0X20B)其中CM表示类别 、对const变量要求在变量命名规则前加入c_,即:c_+变量命名规则；例如: constchar*c_szFileName; 2、命名规范标准: 命名应该尽量用英文表达出完成功能遵循动宾结构命名法则名中动词在前,并在命名前加入前缀名长度不得少于8个字母 例如: longcmGetDeviceCount(); 3、参数规范标准: 、参数名称命名参照变量命名规范标准 、为了提高运行效率减少参数占用堆栈传递大结构参数律采用指针或引用方式传递 、为了便于其他员识别某个指针参数是入口参数还是出口参数同时便于编译器检查应该在入口参数前加入const标志如: cmCopyString(constchar*c_szSource,char*szDest) 4、引出规范标准: 对于从动态库引出作为 2次开发公开为了能和其他以及Windows区分采用类别前缀+基本命名规则思路方法命名例如:在对动态库中引出个图象编辑定义为imgFunctionname(其中img为image缩写) 现给出 3种库命名前缀: 、对通用库采用cm为前缀 、对 3维库采用vr为前缀 、对图象库采用img为前缀 Page对宏定义结果代码用同样前缀 5、文件名(包括动态库、组件、Control控件、工程文件等)命名规范标准: 文件名命名要求表达出文件内容要求文件名长度不得少于5个字母严禁使用象file1,myfile的类文件名 3、注释规范标准: 1、头注释 对于应该从“功能”“参数”“返回值”、“主要思路”、“思路方法”、“日期” 6个方面用如下格式注释: /介绍说明开始 / /功能:从个String中删除另个String /参数:strByDelete,strToDelete /(入口)strByDelete:被删除串(原来串) /(出口)strToDelete:要从上个串中删除串 /返回:找到并删除返回1否则返回0(对返回值有编码要/求列出编码) /主要思路:本算法主要采用循环比较思路方法来从strByDelete中找到 /和strToDelete相匹配串对多匹配strByDelete /中有多个strToDelete子串)情况没有处理请参阅: /书名. /思路方法:. /日期:起始日期如:2000/8/21.9:40-2000/8/23.21:45 / 名() /介绍说明结束 、对于某些其部分参数为传入值而部分参数为传出值所以对参数要详细介绍说明该参数是入口参数还是出口参数对于某些意义不明确参数还要做详细介绍说明(例如:以角度作为参数时要介绍说明该角度参数是以弧度(PI),还是以度为单位),对既是入口又是出口变量应该在入口和出口处同时标明等等 、注释应该放置在头文件中在实现文件中该实现部分应该同时放置该注释 、在注释中应该详细介绍说明主要实现思路、特别要注明自己些想法如果有必要则应该写明对想法产生来由对些模仿应该注释上出处 、在注释中详细注明适当思路方法对于返回值处理思路方法等在注释中要强调时危险方面可能出错地方 、对日期注释要求记录