SWAT编程规范.docVIP

“SWAT正式版”开发编程规范 范围： 本规范适用于“SWAT正式版”开发过程，使用C++编程语言、VC开发工具。 程序风格： 各层次缩进的分格采用VC的缺省风格，即每层次缩进为4格，括号位于下一行，要求相匹配的大括号在同一列 正式版中需要有很多的提示信息，所有提示信息必须定义在资源中，方便支持多种语言 对程序使用到的每个文件（包括自己创建和其他程序提取过来）、每个函数、每个变量必须有注释（只针对自己创建的文件中） 命名规则： 文件名命名规则：操作类型+文件名，例如代码浏览视图：CodeBrowserView.h、CodeBrowserView.cpp, 函数命名要满足三级定义规则：端类型_操作类型_函数名称，例如：服务器端的信息添加方法：DSS_Record_Add 使用到的一些名称： 服务器端：DSS、客户端：COS、更改记录端：ARS 项目操作：Work、工程操作：Project、记录操作：Record、查询操作：Query、统计操作：Statistic、报告操作：Report、代码操作：Code、网络操作：Net、用户操作：User 变量名的命名规则 变量类型 命名规则 例子 bool(BOOL) 用b开头 bIsParent short(int) 用n开头 nStepCount long(LONG) 用l开头 lSum char(CHAR) 用c开头 cCount float(FLOAT) 用f开头 fAvg double(DOUBLE) 用d开头 dDeta HANDLE（HINSTANCE） 用h开头 hHandle DWORD 用dw开头 dwWord LPCSTR(LPCTSTR) 用str开头 strString 用0结尾的字符串 用sz开头 szFileName 对于控件变量命名采用控件名缩写+变量名的方式： 控件类型 命名规则 例子 Button 用btn开头 btnOk Edit box 用edt开头 edtFlag Static text 用stc开头 stcCount Combo box 用cob开头 cobSum Progress 用prg开头 prgDeta Tree Control 用trc开头 trcCount Rich Edit 用redt开头 redtWord 指针变量命名的基本规则：“p”+变量类型前缀+命名 全局变量用g_开头,如一个全局的长型变量定义为g_lFailCount，即：变量名=g_+变量类型+变量的英文意思（或缩写） 静态变量用s_开头,如一个静态的指针变量定义为s_plPervInst,即： 变量名=s_+变量类型+变量的英文意思（或缩写） 成员变量用m_开头,如一个长型成员变量定义为m_lCount;即：变量名=m_+变量类型+变量的英文意思（或缩写） 对枚举类型（enum）中的变量，要求用枚举变量或其缩写做前缀。并且要求用大写。 如：enum cmEMDAYS { EMDAYS_MONDAY; EMDAYS_TUESDAY; …… }; 对struct、union、class变量的命名要求定义的类型用大写。并要加上前缀，其内部变量的命名规则与变量命名规则一致。 结构一般用S开头 如：struct ScmNPoint { int nX;//点的X位置 int nY; //点的Y位置 }; 联合体一般用U开头 如: union UcmLPoint { long lX; long lY; } 类一般用C开头 如： class CcmFPoint { public: float fPoint; }; 对一般的结构应该定义为类模板，为以后的扩展性考虑 如： template class TYPE class CcmTVector3d { public: TYPE x,y,z; }; 在函数体的内部，程序员常常用变量记录临时信息，该类变量采用t_+类型+英文缩写的命名方法，例如：t_bIsDelete。 对常量（包括错误的编码）命名，要求常量名用大写，常量名用英文表达其意思。 如：#define CM_FILE_NOT_FOUND CMMAKEHR(0X20B) 其中CM表示类别。 注释规范 文件注释 在SWAT开发过程中工程中所有使用到的文件必须有注释，包括自己创建的文件和引用的其他文件。为了不影响VC编译，建议文件注释放在CPP文件中，参考格式如下： /******************************************************************** 文件名： 创建人： 创建日期： 描述： 修改人： 修