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

国土软件开发部代码规范 (V1.0) 目 录 1. 概述 3 2. 名词解释 3 3. 命名 3 3.1. 文件(file) 3 3.2. 命名空间(namespace) 4 3.3. 接口(interface) 4 3.4. 类(class)/结构体(struct)/枚举(enum)/委托(delegate) 4 3.5. 枚举值(enum item) 5 3.6. 属性(Property) 5 3.7. 函数(function)/方法(Method)/事件(event) 5 3.8. 变量(variance) 6 3.9. 常量(const)/标识符(define) 8 3.10. 数据库表(table)/视图(view)/存贮过程(procedure) 8 3.11. 数据库表字段(Field) 9 4. 代码布局 9 4.1. 空格分隔 10 4.2. 缩进 12 4.3. 换行 13 4.4. 区段 15 5. 错误处理 16 6. 注释 17 6.1. 文档注释 17 6.2. 文件注释 18 6.3. 代码注释 18 概述 在产品或项目系统的开发过程中，需要多个合作才能完成，这就存在着相互沟通与合作的情况。在现实中，人与人的沟通要有统一的语言，统一的语法，统一的语汇，同样要在代码上实现很好的沟通，也要有统一的语言，统一的语法和统一的书写规范。 因为开发语言的选择同时就固定了语法，因此本文档的主要内容将是定义代码的书写规范，解决开发过程中由于代码风格不一致导至阅读和维护的困难。阅读对象是全体开发人员及系统维护人员。 名词解释 匈牙利命名法：名字可以使用多个单词组合，每个单词第一个字母大写，其余小写，如果是专有名简写，则全部大写。如：Connection，GetMyInfo，GIS。 类成员：用于描述一类事物特性的集合，分为属性和行为。其称谓在不同语言叫法不一样： C++对属性称成员变量，对行为称成员函数； C#对属性进行了扩展，用于描述类或成员本身的属性称特性（Attribute，也是元数据），用于类所描述事物的属性称字段（Field），为了控制字段合法性但又象字段一样使用的封装称属性（Property）； C#对行为也进行了扩展，类内部所具有的行为称方法（Method），用于通知外部的行为称事件（Event，但.NET认为事件变量是字段，因此可以通过遍历字段得到事件变量）。 命名 文件(file) 保持与文件内定义的类名一致，如果文件内包含多个类时，命名应概括出此文件的主要功能或目的，并以匈牙利法命名。如： FormLogin.cs CommUtility.cs PrintHelper.cs 命名空间(namespace) 按“公司名.项目名.功能名.子功能名”格式命名，各级名按匈牙利法命名。其中，公司名固定为SouthGIS，子功能名视需要添加。如： SouthGIS.CMS.SysSetting SouthGIS.CMS.Common.PrintHelper 接口(interface) 接口主体名按匈牙利法命名，并加大写字母I前缀。如： interface IDbCommand 类(class)/结构体(struct)/枚举(enum)/委托(delegate) 按匈牙利法命名。如： class Connection{…} struct UserInfo{…} enum CommandType{…} 常用类型的命名约定： 窗体/页面/对话框 FormXXX class FormLogin 界面控件 CtrlXXX class CtrlConnPanel 用于事件处理的委托 XXXEventHandler delegate void CancelEventHandler(object sender,CancelEventArgs e) 用于回调的委托 XXXCallback delegate int DownloadedCallback 功能性静态类 XXXHelper static class PrintHelper 枚举值(enum item) 1.使用枚举值需要枚举名时（比如C#语言），按匈牙利法命名。如： Text = 0 2.使用枚举值不需要枚举名时（比如C++语言），主体名按匈牙利法命名，并添加枚举名前缀并以下划线分隔。如： CT_Text = 0 注： 前缀规则如下： 如果枚举名只是一个单词时，取前3个字符大写。如： enum Adjustment { ADJ_Left = 0, ADJ_Right = 1 } 如果枚举名由两个或以上单词组成时，取每个单词首字母大写。如： enum CommandType { CT_Text = 0, CT_Table = 1,