软件编码规范.docx

天正软件编码规范命名规范1、通则1.1、在所有命名中，都应使用标准的英文单词或缩写，避免使用汉语拼音。1.2、所有命名都应遵循达意原则，即名称应含义清晰、明确。1.3、所有命名都不易过长，在可表达清晰的前提下越简洁越好。1.4、所有命名都应尽量使用全称。1.5、在类型名称特别复杂的时候，应使用typedef来定义别名。2、标识符2.1、标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基'本可以理解的缩写，避免使人产生误解。（较短的单词可通过去掉“元音''形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写）如下单词的常用缩写applicationappargumentargaverageavgblockblkbufferbufcommandcmdcontrolctrldatabasedbdeletedeldescriptiondescdialogdigdictionarydictdimensiondimdistancedistdocumentdocentityentescapeescflagfigincreaseincinformationinfolengthlenVC++中常用控件缩写AnimateaniCheckBoxchkComboBoxcmbEditedtGroupBoxgrpListBoxIstPicturepiclibrarylibmanagermgrmemorymemmessagemsgobjectobjpasswordpwdpicturepicploylineplinepointerptrpositionposrecordrecreferencerefresourcerscscreenscrserversrvsourcesrcsystemsystemptmptexttxtversionverwindowwndProgressprgPushButtonbtnRadioButtonradScrol旧arsbSlidersldStaticstcTabControltab2.2、长的标识符应使用缩写来缩短长度，而特短的标识符应该避免使用缩写。更恰当：intiFlagHMODULEhLoadedSysRsc不恰当：intiFIgHMODULEhLoadedSystemResource2.3、变量和封装体命名中单词或缩写的第一个字母应大写，其它字母小写，单词和单词之间直接连接，不得有其它字符。在宏定义中全部用大写，单词与单词之间必须用下划线连接。9.6、注释应与其描述的代码相近，对代码的注释应放在其上方，不可放在下方，并与其上面的代码用空行隔开，对enum体中成员和case语句的值做注释时可以放在右方。注释与所描述内容进行同样的缩排。避免在一行代码或表达式的中间插入注释。在关系较为紧密的一段代码之前应给予注释，表达下面代码的功能、意图、算法等。分支判断10.1.BOOL/bool布尔值的判断正确：错误：if(bFlag)if(TRUE==bFlag)if(!bFlag)if(FALSE==bFlag)10.2.float/double浮点值的判断正确：错误：if(fabs(dValue1-dValue2)<EPS)if(dValue1==dValue2)10.3.指针的判断正确：不恰当：if(NULL==pValue)if(0==pValue)10.4.每个分支条件应该写注释加以说明o10.5.对于case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。10.6.在case语句中不应出现具体数值的标号，而应用宏或枚举类型代替。正确：不恰当：#defineBOX_TYPE1switch(iType)switch(iType){{easel:caseBOX_TYPE:break;break;}}10.7、一般地，if判断中if和else要齐全,switch分支中所有case和default要齐全。循环10、9.7、9.8、9.9、11、11.1.11.2.11.3.尽量减少循环体内的工作量，尽量减少循环层次。在多重循环中，应该将最忙的循环放在最内层。对代码效率有要求或循环体较小时，避免在循环体内声明变量，应将变量声明放在循环体之外；避免循环体内包含判断语句，应将循环体放在判断语句的代码块中。循环判断条件应该有注释加以说明。12、第三方代码和开发包（组件）12.1、推荐参考或引用第三方的源代码或开发包（组件）。引入的源代码或开发包（组件）必须成熟高效、具有源代码、没有版权问题，否则未经允许不得引入。在引入第三方的源代码时，必须完全读懂和理解引入的代码，必须对源代码的编码规范进行修改，添加注释，以符合当前项目的