.Net开发规范.doc

《.Net开发规范.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、.net开发规范目录1.概述42.命名规范42.1指导性原则42.1.1使用正确的大小写风格42.1.2使用描述性英文名称42.1.3使用易读的名称42.1.4尽量避免在名称中使用编码52.1.5同义词中使用固定的单词52.1.6保持词义的前后一致52.1.7名词和动词的选用52.1.8使用计算机专业术语52.1.9必要时可使用业务术语62.1.10避免误导62.1.11名词需要语境说明62.1.12不要添加人为的语境62.1.13避免名称差别不明显造成混淆62.2大写风格62.2.1Pascal风格72.2.2Camel风格72.2.3大

2、写风格72.2.4大写小结72.3单词选择82.3.1缩写82.4命名空间92.5类和类成员92.5.1类的命名指南92.5.2Attribute命名指南102.5.3枚举命名指南102.5.4静态类属性名102.5.5参数名102.5.6方法命名指南112.5.7属性命名指南112.5.8事件命名指南112.6大小写敏感123.程序注释规范123.1注释编写准则123.2模块注释133.3类的注释133.4类成员方法的注释153.5类成员属性、常量、变量的注释163.6程序注释164.代码书写规范164.1排版规范165.类成员使用规范2

3、05.1属性使用指南205.1.1只读和只写的属性225.2事件使用指南225.3方法使用指南235.3.1方法重载指南235.4构建函数使用指南245.5类的成员变量使用指南255.6参数名称指南266.类型使用指南276.1类使用指南276.1.1基类使用指南276.2值类型使用指南286.2.1结构使用指南286.2.2枚举使用指南286.3程序代理使用指南306.4程序属性(Attribute)的使用307.异常的产生和处理307.1标准异常类型337.2异常的包装WrappingExceptions348.数组使用指南348.1数

4、组vs.集合348.1.1集合348.1.2集合中可索引的属性348.1.3数组值属性358.2返回空数组359.数据库设计开发规范359.1命名规范359.2字段设计要求369.3视图使用原则369.4存储过程建立规则369.5函数建立规则369.6触发器使用要求361概述在建设过程中，将涉及到在新的VisualStudio.NET以及.NETFramework平台上的开发工作。同时，设计人员、开发人员和测试人员较多。为了使应用程序的结构和编码风格标准化，便于阅读和理解编码，以提高开发效率和产品的标准化，制订一套开发规范和标准势在必行。此

5、外，好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。希望开发人员严格遵守此套开发规范和标准，并落实到自己的程序中。一组通用目的的编码约定应该定义完成上述目的所必需的、能让程序员自由地创建程序逻辑和功能流程的最小的要求。最小编码约定的目的是使程序易于阅读和理解，从而指导程序员更好地完成开发任务。本规范主要针对使用VisualStudio.NET以及.NETFramework开发的基于Web的应用系统。2命名规范2.1指导性原则命名是编程的核心。能够对变量和函数/过程进行表意清晰而准确的命名，就能使程序的

6、可读性大大提高，达到不说自明的效果。真正的名称是深入认真思考一个对象的生态环境后才能给出的。程序设计人员只有在充分理解并把握整个系统时，才可能给出真正合适的名字。如果名称选用恰当，一切就显得很自然，各部分关系清晰，意义可以推导而出，阅读程序时可以按常识推理，从而减小程序员对已有程序的阅读和理解困难，提高工作效率，使新程序员能在尽量短的时间内进入角色。以下章节描述了程序命名的一些指导性原则。2.1.1使用正确的大小写风格为保证良好的程序可读性，对命名的大小写必须按照一致的规定编写，主要包括Pascal风格和Camel风格两种，下面将会有专门的

7、章节进行详细说明。1.1.1使用描述性英文名称为保证程序的可读性，要采用准确描述其意义的名字。英语是国际通用语言，绝大多数商业类库或函数库代码都是由英语编写的。要与标准接轨，充分利用网上的程序资源，应尽量使用英语命名。1.1.2使用易读的名称如果不可读或不易读，则不便于讨论和交流。因此我们要尽量使用大众化名称，避免使用不常用的单词。1.1.3尽量避免在名称中使用编码对名称使用编码就需解码才能理解。少数几个前缀字母有助于区分名称类别。但为了追求风格而过分使用前缀和后缀就会造成生涩难懂的名字。例如SRD2T3。含有编码的名称一般都没有可读性。当

8、然，任何编码，只要科学，时间久了都能被掌握。但是，掌握编码需要新成员的额外精力，增加了适应难度，因此应尽量避免。1.1.4同义词中使用固定的单词首先，我们应尽量使用英语词汇，因为