VC程序开发规范.doc

VC程序代码编写标准指南一、编码要求基本要求程序结构清析简单易懂单个函数的程序行数不得超过行。打算干什么要简单直接了当代码精简避免垃圾程序。尽量使用标准库函数和公共函数。不要随意定义全局变量尽量使用局部变量。使用括号以避免二义性。可读性要求可读性第一效率第二。保持注释与代码完全一致。每个源程序文件都有文件头说明说明规格见规范。每个函数都有函数头说明说明规格见规范。主要变量（结构、联合、类或对象）定义或引用时注释能反映其含义。常量定义（DEFINE）有相应说明。处理过程的每个阶段都有相关注释说明。在典型算法前都有注释。利用缩进来显示程序的逻辑结构缩进量一致并以Tab键为单位定义Tab为个字节。循环、分支层次不要超过五层。注释可以与语句在同一行也可以在上行。空行和空白字符也是一种特殊注释。一目了然的语句不加注释。注释的作用范围可以为：定义、引用、条件分支以及一段代码。注释行数（不包括程序头和函数头说明部份）应占总行数的到。结构化要求禁止出现两条等价的支路。禁止GOTO语句。用IF语句来强调只执行两组语句中的一组。禁止ELSEGOTO和ELSERETURN。用CASE实现多路分支。避免从循环引出多个出口。函数只有一个出口。不使用条件赋值语句。避免不必要的分支。不要轻易用条件分支去替换逻辑表达式。正确性与容错性要求程序首先是正确其次是优美无法证明你的程序没有错误因此在编写完一段程序后应先回头检查。改一个错误时可能产生新的错误因此在修改前首先考虑对其它程序的影响。所有变量在调用前必须被初始化。对所有的用户输入必须进行合法性检查。不要比较浮点数的相等如：*==不可靠程序与环境或状态发生关系时必须主动去处理发生的意外事件如文件能否逻辑锁定、打印机是否联机等。单元测试也是编程的一部份提交联调测试的程序必须通过单元测试。可重用性要求重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。公共控件或类应考虑OO思想减少外界联系考虑独立性或封装性。公共控件或类应建立使用模板。二、编码规范、适用范围本标准适用于利用VisulC,BorlandC进行软件程序开发的人员。、变量命名命名必须具有一定的实际意义,形式为xAbcFgh,x由变量类型确定,Abc、Fgh表示连续意义字符串,如果连续意义字符串仅两个,可都大写如OK具体例程:BOOL类型bEnablech*charchTextc*类对象cMain（对象实例）h*Handle（句柄）hWndi*intn*无符号整型p*指针sz,str*字符串wWORDx,y坐标Char或者TCHAR类型与WindowsAPI有直接联系的用szAppName形式否则用FileName形式,单个字符也可用小写字母表示Int类型nCmdShowLONG类型lParamUINT类型uNotifyDWORD类型dwStartPSTR类型pszTipLPSTR类型lpCmdLineLPTSTR类型lpszClassNameLPVOID类型lpReservedWPARAM类型wParam,LPARAM类型lParamHWND类型hDlgHDC类型hDCHINSTANCE类型hInstanceHANDLE类型hInstance,HICON类型hIconintiTmpfloatfTmpDWORDdw*String,AnsiStringstr*m类成员变量mnVal,mbFlagg全局变量gnMsg,gbFlag局部变量中可采用如下几个通用变量：nTempnResultIJ（一般用于循环变量）。其他资源句柄同上、常量命名和宏定义常量和宏定义必须具有一定的实际意义常量和宏定义在#include和函数定义之间常量和宏定义必须全部以大写字母来撰写,中间可根据意义的连续性用下划线连接,每一条定义的右侧必须有一简单的注释,说明其作用资源名字定义格式:菜单:IDMXX或者CMXX位图:IDBXX对话框:IDDXX字符串:IDSXXDLGINIT:DIALOGXXICON:IDRXX、函数命名函数原型说明包括引用外来函数及内部函数外部引用必须在右侧注明函数来源：模块名及文件名,如是内部函数只要注释其定义文件名第一个字母必须使用大写字母,要求用大小写字母组合规范函数命名,必要时可用下划线间隔,示例如下：voidUpdateDBTfgd(TRACKNAME)ModuleName:rsdwcvoidPrintTrackData(TRACKNAME)ModuleName:rterncvoidImportantPoint(void)ModuleName:rsdwcvoidShowChar(int,int,chtype)LocalModulevoidScrollUpV(int,int)LocalModule、结构体命名结构体类型命名必须全部用大写字母,原则上前面以下划线开始结构体变量命名必须用大小写字母组合第一个字母必须使用大写字母,必要时可用下划线间隔。对于私有数据区必须注明其所属的进程。全局数据定义只需注意其用途。示例如下：typedefstruct{charszProductNamecharszAuthorcharszReleaseDatecharszVersionunsignedlongMaxTablesunsignedlongUsedTables}DBSDATABASEDBSDATABASEGdataBase、控件的命名：用小写前缀表示类别用小写前缀表示类别：fm窗口cmd按钮cobcombo下拉式列表框txt文本输入框lablabal标签imgimage图象picpicturegrdGrid网格scr滚动条lst列表框frmfram、注释原则上注释要求使用中文文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复杂的算法需要加上流程说明函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明程序中注释包括:修改时间和作者、方便理解的注释等引用一:文件开头的注释模板********************************************************************文件名:**Copyright(c)*********公司技术开发部**创建人:**日期:**修改人:**日期:**描述:****版本:********************************************************************引用二:函数开头的注释模板*******************************************************************函数名:**输入:a,b,c**a**b**c**输出:x**x为,表示**x为,表示**功能描述:**全局变量:**调用模块:**作者:**日期:**修改:**日期:**版本****************************************************************引用三:程序中的注释模板***注释内容***、程序a程序编码力求简洁结构清晰避免太多的分支结构及太过于技巧性的程序尽量不采用递归模式。b编写程序时亦必须想好测试的方法换句话说”单元测试”的测试方案应在程序编写时一并拟好。c注释一定要与程序一致。d版本封存以后的修改一定要将老语句用**封闭不能自行删除或修改,并要在文件及函数的修改记录中加以记录。e程序中每个block的开头”{"及"}”必须对齐嵌套的block每进一套缩进一个tabTAB为个空格,block类型包括if、for、while、do等关键字引出的。f对于比较大的函数每个block和特殊的函数调用都必须注明其功能举例如下：countdivisor=freqcomputethepropercountOutByte((unsignedshort),(unsignedchar))tellthatacountiscomingOutByte((unsignedshort),countc)sendloworderbyteOutByte((unsignedshort),countc)sendhighorderbyte×××××××××××××××××××××××××××××××××××××××bcbdelphi中的变量命名：遵循匈牙利命名法命名必须有意义制定如下规定窗体：以大写的W开始如About版权窗体命名为WAbout文件：以大写的F开始如About版权窗体文件命名为FAboutcpp按钮(Button)：如退出按钮命名为btnExit……基类：加base标记如报表基类,窗体命名为：WBaseRep,文件命名为FBaseRepcpp