《开发人员手册VSNET开发规范篇》由会员分享，可在线阅读，更多相关《开发人员手册VSNET开发规范篇（47页珍藏版）》请在金锄头文库上搜索。
1、密级：秘密 开 发 人 员 手 册-VS.NET开发规篇文档最后修订者及日期：立新2009-3-16本版文件批准人及日期：浪潮集团通用软件目录1导言51.1目的51.2适用围51.3术语定义51.4参考资料51.5版本更新记录52使用的开发工具：63程序源代码风格定义63.1代码结构风格63.2注释风格73.2.1单行注释83.2.2多行注释83.2.3文档型注释83.2.4文档型注释规113.3代码书写风格143.3.1缩进143.3.2空行143.3.3换行153.3.4空格153.3.5花括号164命名规164.1大写规则164.2区分大小写174.3缩写184.4措词194.5避免类型
2、名称混淆204.6命名空间命名规224.7类命名规234.8接口命名规244.9属性命名规254.10枚举类型命名规254.11静态字段命名规254.12参数命名规264.13方法命名规264.14属性命名规264.15事件命名规284.16数据库对象命名规294.16.1数据库名（开发过程中）294.16.2数据库表294.16.3字段304.16.4存储过程命名约定314.16.5触发器（插入，更新，删除）命名约定314.16.6视图命名约定314.16.7自定义数据类型命名约定314.16.8自定义函数命名约定324.17数据库表结构设计规334.18数据库存储过程编写规345界面规34
3、5.1总则345.2遵从原则345.3色彩搭配355.4屏幕大小355.5主控页面355.5.1主页：登录窗口355.5.2主操作页分成三个区域：标题菜单区、系统管理区、操作区365.5.3浏览器365.6各种页面模板应用的场景375.6.1字典类375.6.2单据类385.6.3管理类395.6.4索引类405.6.5Tab页类405.6.6响应式窗口类405.6.7查询结果/报表类406提示信息规416.1总则416.2提示信息417热键定义、帮助及使用规417.1总则417.2规418单元测试规（从开发人员角度）428.1总则428.2测试规429配置管理规（从开发人员角度）439.1总
4、则439.2开发前的准备439.3开发过程中的规则4410程序模板4410.1总则4410.2字典模板4510.3单据模板4510.4查询模板4511其他规则及建议461 导言1.1 目的本文档是为基于Microsoft公司的Visual Studio .Net - C#.Net系列开发工具进行软件开发的一个规性文件。其目的是： 保证软件开发过程中有一个统一的标准可以进行参照：包括类库、公共接口、设计模式、命名规等。 能够合理的使用公用资源1.2 适用围本文档主要是基于目前三层架构开发模式中的SmartClient方式进行描述的，并同样适合于传统的三层架构：A 术语定义可访问性修饰符：publ
5、ic（公有）、internal（部公有）、proected（受保护）、protectedinternal（受保护或部公有）、private（私有）。在此约定好中英文对照名称。非私有包括：公有、部公有、受保护、受保护或部公有。1.4 参考资料1. C# Language Specification1.2.doc2. C# Language Specification 2.0.doc1.5 版本更新记录版本/修订版修改确认日期修改容概述起草人审核人备注1.02003-10初始版本鞠强曲丽君2.02008-03代码风格章节调整命名规细化样式调整立新2 使用的开发工具： Microsoft Visua
6、l Studio .Net 2005 - C#.Net3 程序源代码风格定义源代码风格规是在编写源代码文件时，对于书写格式和规则的统一要求。编写源代码最基本的目标是能够经过编译生成可执行程序。此外，源代码的另一个主要目标是为了阅读，源代码不仅仅是为了编译器能够读懂，同时也是为了人能够读懂，且易于读懂。这就如写文章的句读、段落、章节等类似，如果没有一种良好的书写风格和习惯，不仅仅会使写出的文章难以阅读，而且可能会造成不少曲解。有句话叫“文如其人”，代码也同样是“文如其人”。此外，作为一个协作密切的开发团队，非常有必要保持一致的代码书写风格，它有助于团队开发保持高效（沟通交流、代码阅读、工作交接、
7、工作延续性等方面）。3.1 代码结构风格对于每一个代码文件（*.cs），它的容分为如下两个部分：u 使用的命名空间u 类型定义使用的命名空间，要求必须都声明在代码文件的最前方。建议.net framework中定义的命名空间放在最上面，然后根据与当前代码关系的远近依次排列，对于引用的命名空间，按照引用来源分段列示，段与段之间用空行分隔。示例图如下：using System;using System.Collections;using System.Collections.Generic;using DevExpress.XtraTreeList;using DevExpress.XtraTre
8、eList.Nodes;using Genersoft.Platform.Coremon;using Genersoft.Platform.Core.Error;31 使用的命名空间代码示例在类型定义部分，一个代码文件原则上只包含一个如下类型的定义：类、接口、结构、枚举。这样有利于构造出条理清晰的代码文件结构，一目了然。对于委托的定义，可考虑在一个代码文件中集中定义聚度较高的一类枚举。对于类的定义，按照一下顺序定义：u 常量u 字段u 构造函数u 析构函数u 属性u 方法u 事件所有的类成员必须显式的声明访问修饰限定符（public、internal、protected、private）。为使
9、类型具有良好的封装性，其中字段类型只能声明为private。对于接口和结构体定义，其成员声明顺序与类定义相同。每行代码只允许写一条语句。每行代码写多条语句往往会造成调试定位、注释以及阅读的困难。3.2 注释风格传统的注释风格：单行注释符号“/”和多行注释符号“/* */”在C#中依然可以使用。在.NET中，提供了额外的XML文档注释标记（Tags for Documentation Comments）。3.2.1 单行注释单行注释，即形式为“/”的注释。单行注释用于方法的代码注释。如对局部变量声明的注释或代码行、代码段的注释。单行注释可单独一行，如果仅仅针对一句注释，且不影响换行，可放于代码行
10、后部。单行注释也可以用于临时屏蔽不用的代码行，在开发完毕后应及时清理。特殊的，单行注释用于代码文件声明的注释，见代码文件注释。3.2.2 多行注释多行注释，即形式为“/* */”的注释。一般的，不建议在代码中使用多行注释。多行注释可用于临时屏蔽不用的代码行，在开发完毕后应及时清理。3.2.3 文档型注释文档型注释，即XML文档注释标记（Tags for Documentation Comments），该类注释是.Net定义的Xml标签，在声明接口、类、方法、属性、字段都应该使用该类注释，除了在阅读代码时了解代码语义之外，可通过该类注释生成代码类库的帮助文档（*.chm）。这些标记包括如下表的全
11、部容：descriptiondescription：对象的摘要。应当用于描述类型成员。使用 以提供有关类型本身的信息。descriptionname：方法参数名。description：参数的说明。应当用于方法声明的注释中，以描述方法的一个参数。 name：引用的参数名。 标记为您提供了一种指示词为参数的方法。可以处理 XML 文件，从而用某种独特的方法格式化该参数。descriptionmember：对可从当前编译环境中获取的异常的引用。编译器检查到给定异常存在后，将 member 转换为输出 XML 中的规化元素名。description：异常使用条件说明。 标记使您可以指定类能够引发的异
12、常。 descriptionDescription：返回值的说明。 标记应当用于方法声明的注释，以描述返回值。cref = member：对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。使您得以从文本指定。使用 指示希望在“请参阅”一节中出现的文本。cref = member：对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。使您得以指定希望在“请参阅”一节中出现的文本。使用 从文本descriptiondescription：代
13、码示例。使用 标记可以指定使用方法或其他库成员的示例。一般情况下，这将涉及到 标记的使用。ctexttext：指示为代码的文本。为您提供了一种将说明中的文本标记为代码的方法。使用 将多行指示为代码contentcontent：标记为代码段的文本。记为您提供了一种将多行指示为代码的方法。使用指示应将说明中的文本标记为代码 property-descriptionproperty-description：属性取值的说明。 标记使您得以描述属性。请注意，当在 Visual Studio .NET 开发环境过代码向导添加属性时，它将会为新属性添加 标记。然后，应该手动添加 标记以描述该属性所表示的值。contentContent：段落文本。用于诸如 或 等标记，使您得以将结构添加到文本中。inc
