国土软件开发部代码规范(v1.0)

《国土软件开发部代码规范(v1.0)》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、国土软件开发部代码规范（V1.0）

2、2010年07月07日国土软件开发部代码规范(V1.0)SOUTH

3、南方数码19国土软件开发部代码规范（V1.0）

4、2010年07月07日目录1.概述32.名词解释33.命名33.1.文件(file)33.2.命名空间(namespace)43.3.接口(interface)43.4.类(class)/结构体(struct)/枚举(enum)/委托(delegate)43.5.枚举值(enumitem)53.6.属性(Property)53.7.函数(function)/方法(Method)/事件(e

5、vent)53.8.变量(variance)63.9.常量(const)/标识符(define)83.10.数据库表(table)/视图(view)/存贮过程(procedure)83.11.数据库表字段(Field)94.代码布局94.1.空格分隔104.2.缩进124.3.换行134.4.区段155.错误处理166.注释176.1.文档注释176.2.文件注释186.3.代码注释18SOUTH

6、南方数码19国土软件开发部代码规范（V1.0）

7、2010年07月07日1.概述在产品或项目系统的开发过程中，需要多个合作才能完成，这就存在着

8、相互沟通与合作的情况。在现实中，人与人的沟通要有统一的语言，统一的语法，统一的语汇，同样要在代码上实现很好的沟通，也要有统一的语言，统一的语法和统一的书写规范。因为开发语言的选择同时就固定了语法，因此本文档的主要内容将是定义代码的书写规范，解决开发过程中由于代码风格不一致导至阅读和维护的困难。阅读对象是全体开发人员及系统维护人员。2.名词解释匈牙利命名法：名字可以使用多个单词组合，每个单词第一个字母大写，其余小写，如果是专有名简写，则全部大写。如：Connection，GetMyInfo，GIS。类成员：用于描述一类事物特性的集合，分为

9、属性和行为。其称谓在不同语言叫法不一样：²C++对属性称成员变量，对行为称成员函数；²C#对属性进行了扩展，用于描述类或成员本身的属性称特性（Attribute，也是元数据），用于类所描述事物的属性称字段（Field），为了控制字段合法性但又象字段一样使用的封装称属性（Property）；²C#对行为也进行了扩展，类内部所具有的行为称方法（Method），用于通知外部的行为称事件（Event，但.NET认为事件变量是字段，因此可以通过遍历字段得到事件变量）。3.命名3.1.文件(file)SOUTH

10、南方数码19国土软件开发部代码规范（

11、V1.0）

12、2010年07月07日保持与文件内定义的类名一致，如果文件内包含多个类时，命名应概括出此文件的主要功能或目的，并以匈牙利法命名。如：FormLogin.csCommUtility.csPrintHelper.cs1.1.命名空间(namespace)按“公司名.项目名.功能名.子功能名”格式命名，各级名按匈牙利法命名。其中，公司名固定为SouthGIS，子功能名视需要添加。如：SouthGIS.CMS.SysSettingSouthGIS.CMS.Common.PrintHelper1.2.接口(interface)接口主体

13、名按匈牙利法命名，并加大写字母I前缀。如：interfaceIDbCommand1.3.类(class)/结构体(struct)/枚举(enum)/委托(delegate)按匈牙利法命名。如：classConnection{…}structUserInfo{…}enumCommandType{…}常用类型的命名约定：窗体/页面/对话框FormXXXclassFormLogin界面控件CtrlXXXclassCtrlConnPanel用于事件处理的委托XXXEventHandlerdelegatevoidCancelEventHandle

14、r(objectsender,CancelEventArgse)用于回调的委托XXXCallbackdelegateintDownloadedCallback功能性静态类XXXHelperstaticclassPrintHelperSOUTH

15、南方数码19国土软件开发部代码规范（V1.0）

16、2010年07月07日1.1.枚举值(enumitem)1.使用枚举值需要枚举名时（比如C#语言），按匈牙利法命名。如：Text=02.使用枚举值不需要枚举名时（比如C++语言），主体名按匈牙利法命名，并添加枚举名前缀并以下划线分隔。如：CT_Tex

17、t=0注：前缀规则如下：如果枚举名只是一个单词时，取前3个字符大写。如：enumAdjustment{ADJ_Left=0,ADJ_Right=1}如果枚举名由两个或以上单词组成时，取每个单词首字母大写。如