.Net开发规范

1、.net 开发规范 精选文库 3. 3 1. 概述 2.命名规范 2.1 2.1.1 2.1.2 2.1.3 2.1.4 2.1.5 2.1.6 2.1.7 2.1.8 2.1.9 2.1.10 2.1.11 2.1.12 2.1.13 2.2 2.2.1 2.2.2 2.2.3 2.2.4 2.3 2.3.1 2.4 2.5 指导性原则 使用正确的大小写风格. 使用描述性英文名称 使用易读的名称 尽量避免在名称中使用编码 同义词中使用固定的单词. 保持词义的前后一致 名词和动词的选用 使用计算机专业术语 必要时可使用业务术语. 避免误导 名词需要语境说明 不要添加人为的语境 避免名称差别不明

2、显造成混淆 大写风格 Pascal 风格 Camel风格 大写风格 大写小结 单词选择 缩写 命名空间 类和类成员 类的命名指南 2.5.2 Attribute命名指南 2.5.3 枚举命名指南. 2.5.4 静态类属性名. 2.5.5 参数名 2.5.6 方法命名指南. 2.5.7 属性命名指南 2.5.8 事件命名指南. 2.6 大小写敏感 程序注释规范 3.1 注释编写准则. 3.2 模块注释 3.3 类的注释 3.4 类成员方法的注释 2.5.1 目录 8 9 10 10 11 11 11 12 12 12 12 13 13 14 14 14 15 15 17 精选文库 19 3.5

3、3.6 类成员属性、常量、变量的注释 程序注释 19 19 20 4.1 排版规范 20 4. 代码书写规范 23 5.1 5.1.1 5.2 5.3 5.3.1 5.4 5.5 5.6 属性使用指南 只读和只写的属性. 事件使用指南 方法使用指南 方法重载指南 构建函数使用指南. 类的成员变量使用指南 参数名称指南 23 26 26 27 27 28 28 30 5. 类成员使用规范 30 6.1 6.1.1 6.2 6.2.1 6.2.2 6.3 6.4 类使用指南 基类使用指南 值类型使用指南 结构使用指南 枚举使用指南 程序代理使用指南 程序属性(ATTRIBUTE )的使用 31 3

4、1 31 31 32 33 33 6. 类型使用指南 34 7.1 7.2 标准异常类型 异常的包装 WRAPPING EXCEPTIONS 36 37 7. 异常的产生和处理 8.1 数组VS.集合 38 8.1.1 集合 38 8.1.2 集合中可索引的属性 38 8.1.3 数组值属性 38 8.2 返回空数组 38 数据库设计开发规范 错误!未定义书签。 9.1 命名规范 错误!未定义书签。 9.2 字段设计要求 错误!未定义书签。 9.3 视图使用原则 错误!未定义书签。 9.4 存储过程建立规则 错误!未定义书签。 9.5 函数建立规则 错误!未定义书签。 9.6 触发器使用要求

5、错误!未定义书签。 38 9. 8.数组使用指南 1概述 在建设过程中，将涉及到在新的Visual Studio.NET 以及.NET Framework 平台上的开 发工作。同时，设计人员、开发人员和测试人员较多。为了使应用程序的结构和编码风格标 准化，便于阅读和理解编码， 以提高开发效率和产品的标准化，制订一套开发规范和标准势 在必行。此外，好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一 致，并且尽可能的直观。 希望开发人员严格遵守此套开发规范和标准, 并落实到自己的程序 中。 一组通用目的的编码约定应该定义完成上述目的所必需的、 能让程序员自由地创建程序 逻辑和功能流

6、程的最小的要求。最小编码约定的目的是使程序易于阅读和理解, 从而指导程 序员更好地完成开发任务。 本规范主要针对使用 Visual Studio.NET 以及.NET Framework 开发的基于 Web的应用 系统。 2命名规范 2.1指导性原则 命名是编程的核心。能够对变量和函数/过程进行表意清晰而准确的命名，就能使程序 的可读性大大提高， 达到不说自明的效果。 真正的名称是深入认真思考一个对象的生态环境 后才能给出的。程序设计人员只有在充分理解并把握整个系统时, 才可能给出真正合适的名 字。如果名称选用恰当，一切就显得很自然，各部分关系清晰，意义可以推导而出，阅读程 序时可以按常识推理

7、，从而减小程序员对已有程序的阅读和理解困难, 提高工作效率, 使新 程序员能在尽量短的时间内进入角色。 以下章节描述了程序命名的一些指导性原则。 2.1.1使用正确的大小写风格 为保证良好的程序可读性，对命名的大小写必须按照一致的规定编写, 主要包括 Pascal 风格和Camel风格两种，下面将会有专门的章节进行详细说明。 2.1.2使用描述性英文名称 为保证程序的可读性， 要采用准确描述其意义的名字。英语是国际通用语言， 绝大多数 商业类库或函数库代码都是由英语编写的。要与标准接轨，充分利用网上的程序资源, 应尽 量使用英语命名。 2.1.3使用易读的名称 如果不可读或不易读，则不便于讨论

8、和交流。因此我们要尽量使用大众化名称，避免使 用不常用的单词。 2.1.4尽量避免在名称中使用编码 对名称使用编码就需解码才能理解。少数几个前缀字母有助于区分名称类别。但为了追 求风格而过分使用前缀和后缀就会造成生涩难懂的名字。 例如SRD2T3。含有编码的名称一 般都没有可读性。当然，任何编码，只要科学，时间久了都能被掌握。但是，掌握编码需要 新成员的额外精力，增加了适应难度，因此应尽量避免。 2.1.5 同义词中使用固定的单词 首先，我们应尽量使用英语词汇，因为汉语拼音实际上也是一种名称编码，特别是使用 拼音首字母，即使是懂汉语拼音的人也未必能理解。有了用英语命名的前提，我们还应该注 意：

9、一个抽象概念可能有多个表述同义词，选择一个，始终如一。如对同一动作，在不同类 中选用不同的名称，比如，fetch, retrieve和get，那么，使用你的类从事编程的人就要多费 很多精力去理解它们。也就是说，我们应该通过使用一致的名称，创建统一的编程接口，简 化学习的难度。 2.1.6保持词义的前后一致 多数词都有不止一个意思，但在同一个系统中，应始终保持同一个意思。这和前面的原 则是相对应的。使用不同的词汇，使人联想不同的接口和 /或操作。同样，使用同样的词汇, 使人联想相同的接口和/或操作。如果我学过使用DeviceManager:add(),我就会期望可以使 用ProtocolMana

10、ger:add().这是根据名称产生的联想，甚至连想到可以使用 *Manager:add()。 要保证这种联想能成立， 前后词义必须一致。 如果自己设计一个系统， 要尽量做到保持词义 的一致。记住，在两个完全不同的范畴内使用相同的名字是很不可取的。 2.1.7名词和动词的选用 类和对象应当使用名词或名词短语命名。方法中强调过程用动词， 返回值用名词。作为 一名设计人员，可能不太在意这些命名的琐事。尝试使用你设计的类去编写一段用户程序, 看看有多少别扭或混乱的地方，一定可以反过来有助你改进设计。 2.1.8使用计算机专业术语 尽量使用约定成俗的惯用语、计算机科学术语、算法名称、设计模式名称、数学

11、名词等 软件编程相关名词。 这样似乎有点异端，但这总好过让程序员费劲找客户弄清楚自己原本清 楚的概念，只是由于名称的不同使他们疑惑。我们是讲编码规范，程序员大多数是计算机专 业的，或对计算机专业已有了深入了解的。很少最终用户会阅读程序，即使有，也是有相当 计算机软件功底的。 相反，程序维护人员必须阅读程序， 所以应尽可能使用计算机术语。如: 运用工厂模式类的命名应该是“名词+Factory ”。 2.1.9必要时可使用业务术语 如果工作的重点不在程序本身，或问题的描述比问题的解决更重要，可使用业务术语。 在分析阶段，使用业务术语比使用计算机术语更好，因为容易被客户理解和接受。 2.1.10避免

12、误导 避免使用已有其它明确意义的名词。例如，hp, aix,和sco被用作UNIX平台及 其变种的名称，如果再用来作为变量或函数名称就很有问题，会引起误解。即使你在解决的 问题用hp是很好的缩写也不应使用hp。 2.1.11名词需要语境说明 只有少数情况下，孤立的一个名字有明确含义。多数情况下，名称需要置于一定的语境 中才有意义。比如，在类中，函数中或注释中。换句话说，在面向对象的语言中，在类属性 的名称中包含类名是多余的。例如，不应该使用 Book.BookTitle，而应该使用Book.Title。 Com pan y. address_和 Customer. address_ 同样都是a

13、ddress,但仅在语境中才有意义，以 下的命名是不可取的：Company, company Address_, Customer.customerAddress_。 2.1.12不要添加人为的语境 不要在类的前面冠以公司名缩写、项目名称缩写或其他标志性前缀。例如，在做知识管 理系统时，把员工类命名成 KmsUser。以上命名法是不可取的，这样势必造成代码重复，影 响代码的重用。如使用同一个类，则KmsUser在其他系统中就显得不和谐了。 编译和解译程序不允许在 2.1.13避免名称差别不明显造成混淆 这个问题源于编写程序仅仅是为了能编译通过或能解译执行。 同一域内用相同的名字指称两个东西。所

14、以，遇到编译问题时，就随便将其中的一个改变一 下。更糟糕的是，原本同一个名称，因拼写错误变成两个名称。这里要说的关键问题是，如 果要区分两样不同的东西，一定要保证名称有实质性的差别。例如，若将一个类命名成 Product，另一个类命名成 ProductInfo或ProductData,就会因差别不明显造成混淆。因为Info 和Data没有具体的意思。同理，不要在 00编程中使用Class或Object作为名称的一部分。 Customerobject 和 Customer 有什么区别？ NameString 比 Name 好吗？难道一个 Name 还 会是浮点数或整数不成？特别要强调的是, 对于

15、大小写敏感的编程环境, 我们不要使用仅有 大小写区别的名字。例如，Customer, customer不应作为两个名字。 2.2大写风格 以下章节描述了不同方式的大写方式.这些术语将在通篇文档中被经常引用 2.2.1 Pascal 风格 这种风格大写每个单词的首字母 BackColor 应在所有由多单词组成的公共描述符中使用这种方式 .举例而言，使用TextColor就比 Textcolor 或 Text_color 更好. 注意不要大写 “连接词”（一个单词中包含了几个单词，但这个单词本身有自己的意 思，如Checkbook）每个组合单词的首字母。应该将这个单词作为一个单词来考虑，而非几 个

16、单词的组合。使用词典决定一个组合词是不是应该作为一个单词来使用。 2.2.2 Camel 风格 这种风格除了第一个单词的首字母，其他单词都应大写首字母，如下所示 back Color 在局部变量参数名或私有类属性名称上使用camel风格。 2.2.3大写风格 PASCAL风格。举 只在少于两个字母的缩写中使用大写。三个以上字母的缩写都应该使用 例而言 System.lO System.Web.UI System.CodeDom 一个另外的情形是和原有的未管理的标志兼容, 而原来常用大写来表示枚举和常量。 通常这 些标志符不应该暴露给外部。 2.2.4大写小结 F表描述了不同类型的描述符该怎么使

17、用大小写 类型 风格 备注 Class Pascal风格 Enu merati on value Pascal风格 Enu merati on type Pascal风格 Event Pascal风格 Excep tio n class Pascal风格 用后缀 Exception. Read-only static field Pascal风格 In terface Pascal风格 用前缀I. Method Pascal风格 Names pace Pascal风格 Prop erty Pascal风格 Public in sta nee field Pascal风格 很少使用，更多使用 P

18、 rotected in sta nee field camel风格 很少使用，更多使用 P arameter camel风格 prop erties. prop erties. 2.3单词选择 不要使用常用的命名空间的名字做类名，举例而言不要使用以下任何单词做类名 System Collect ions Forms Ul 不要使用和以下关键字冲突的识别符，举例而言，避免这样使用: AddHa ndler AddressOf Alias And Ansi As Assembly Auto Base Boolea n ByRef Byte ByVal Call Case Catch CBool

19、CByte CChar CDate CDec CDbl Char CI nt Class CL ng CObj Co nst CShort CS ng CStr CType Date Decimal Declare Default Delegate Dim Do Double Each Else ElseIf End Enum Erase Error Event Exit ExternalSource False Fin alize Fi nally Float For Frie nd Fun cti on Get GetT ype Goto Han dles If Imp leme nts

20、Imp orts In In herits In teger In terface Is Let Lib Like Lo ng Loop Me Mod Module Must In herit MustOverride MyBase MyClass Names pace New Next Not Nothi ng Not In heritable NotOverridable Object On Op tion Op ti onal Or Overloads Overridable Overrides P aramArray P reserve Private Property P rotec

21、ted P ublic RaiseEve nt ReadO niy ReDim Regi on REM RemoveHa ndler Resume Retur n Select Set Shadows Shared Short Si ngle Static Ste p Sto p Stri ng Structure Sub SyncLock The n Throw To True Try Typ eOf Uni code Un til volatile When While With WithEve nts Write On ly Xor eval exte nds in sta nceof

22、package var GetWindow 比 GetWin 更好. 2.3.1 缩写 1、请不要砍掉或抽取识别符的部分来作为名称使用。如使用 2、请不要使用使用不被广泛认可的缩写。 3、只有绝对需要时再使用广为人知的缩写。可以使用 UI 来表示 User In terface，用 OLA P 来表示 On-line Analytical Processing. 4、当使用缩写时，请使用Pascal风格或camel风格来表示超过两个或以上单词缩写的构成。 如用 HtmlButton 而非 HTMLButton，但不要用 System.Io 来取代 System.IO 2.4命名空间 以下模板举

23、例说明了命名空间的命名规则。 .Desig n 因此我们希望看到这样如下命名空间 Microsoft.Media Microsoft.Media.Desig n PowerSoft .Po werBuilder.Math 1、避免两个P UBLISED勺NAMES PACE名称一样的可能。使用公司名称或者一个正式分支的 名称如用 Microsoft.Office 来表示 Microsoft 提供的 Office Automation Classes 。 2、使用一个稳定的被广泛认可的技术名称作为第二层名称 3、不要使用组织的结构层次作为命名空间的层次依据 4、请在DESIGN-TIME命名空间

24、前加上.Design 前缀以表示基础命名空间DESIGN-TIME特 性。女0 System.Windows.Forms.Design 包含了用来设计 System.Wi ndows.Forms 应用 程序的的设计器和相关设计类。 ) 5、使用PASCAL风格，把每个逻辑部件用分隔号分开（如Microsoft.Office.PowerPoint 如果你的品牌采用了非传统方式的命名，那么就延续的你的品牌的命名方式，就算他和通常 的命名空间法则不同。如(NeXT.WebObjects, and ee.cummi ngs ) 6、在适当的地方使用复数命名。例如采用 System.Collection

25、s 而非System.Collection 。 对此例外的是品牌名和缩写。如用 System.IO 而非 System.IOs 。 Debug时就不要使用Debug 7、不要让命名空间和类都使用同样的名字。如，当有个类叫 来作为命名空间的名字。 命名空间结构不需和配件名称结构并行。如，当你决定使用给配件取名叫 MyCompany.MyTechnology.dll 时，这并不需要你得让配件中包含一个叫 MyCompany.MyTechnology 的命名空间。 2.5类和类成员 2.5.1类的命名指南 1、使用名词或名词短语命名类。 2、使用Pascal风格 3、谨慎使用缩写命名类。 4、不要使

26、用任何类前缀（如 0 5、不要使用强调符号。 6、偶尔可能会出现已I作为类名开头的情况， 而这个类又不是一个接口类。这种情况下只 要第二个字母是小写就可以接受。如Ide ntityStore. 7、建议使用组合词来命名派生类。在此情况下，你应该考虑使用基类名称作为派生类名称 的结尾。举例而言，在英语中的”Coffee Cup ”是说的一种杯子，而不是一种咖啡。又如 App licati on Exce pti on 外,而Boolea nSwicth SwitchSerializableAtrnbute 是一种属性。 但对此应该合理的判断，如 Button 是一种 Control虽然Contr

27、ol并没有出现在名字中。 以下是一些正确的命名的例子 P ublic class FileStream p ublic class Butt on p ublic class Stri ng 2.5.2 Attribute命名指南 在自定义属性类的后边应该加上Attribute 作为后缀。 P ublic class ObsoleteAttribute : Attribute 2.5.3 枚举命名指南 使用Pascal风格来命名枚举类型. 2、 使用Pascal风格命名枚举值. 3、 不要使用简写来命名枚举值 ? 不要在枚举前加前缀 （如adXXX来命名 ADO enums, rtfXXX 来

28、命名rich text enums,等.). ? 不要使用在枚举上加后缀 ?使用单数来命名枚举，除非它是一个BIT类属性. 使用复数来命名 BIT类属性。 2.5.4 静态类属性名 1、使用名词，名词短语或简写来命名静态类属性 2、使用PASCAL风格来命名静态类属性 不要使用匈牙利命名法来命名静态类属性名称 2.5.5 参数名 使用有意义的参数名.在所有场合，参数名称和类型应该清楚地描述以决定其反映的意义 使用camel风格来命名参数 .因 使用名称来表现其作用而非表现其类型.我们期望开发工具能提供有效的方式来提供类型信息 此参数名可被更好的用来表现其作用而非类型.偶尔使用基于类型的参数名是

29、完全适当的 不要使用reserved参数。在下个版本中需要更多的数据那么就使用重载。 请不要使用匈牙利命名法来在名称前加前缀 Type GetType (stri ng typ eName) stri ng Format (stri ng format, object args) 2.5.6 方法命名指南 使用动词或动词短语来命名方法。 使用Pascal风格来命名方法.如 RemoveAll() GetCharArrayO In voke() 2.5.7属性命名指南 使用名词或名词短语来命名属性 使用Pascal来命名属性. 可以考虑把属性命名和其类型一样。当属性名和一个类型名一样时，那么一定

30、要让这个属性 就是这个类型。虽然这听起来有点多余，但这是正确的。以下例子说明了正确的属性命名方 法. P ublic enum Color . p ublic class Con trol public Color Color get . set . 以下是错误的命名 P ublic enum Color . p ublic class Con trol 在错误的例子中, 释为 p ublic int Color get . set . Color枚举的成员不可能被引用到，因为Color.xxx的COLOR将被解 Color（ Int）属性，系统将会到System.I nt32中的实例中去访问

31、成员。. 2.5.8 事件命名指南 使用事件 EventHandler来命名HANDLER （代理类型）。如 P ublic delegate void MouseEve ntHa ndler(object sen der, MouseEve ntArgs e); 两个参数取名叫sender和e. sender参数表示触发时间的对象。sender都是object类型，就算是它可以是更明确的类型。 与事件关联的状态被封装到一个事件类的实例中e中.对它应该使用适当明确的事件类型。如 p ublic delegate void MouseEve ntHa ndler(object sen der,

32、MouseEve nt e); 使用EventArgs后缀来命名事件的参数，如 p ublic class MouseEve ntArgs : Eve ntArgs int x; int y; p ublic MouseEve ntArgs(i nt x, int y) this.x = x; this.y = y; p ublic int X get retur n x; p ublic int Y get retur n y; 使用现在时态和过去时态来命名有前”后概念的事件。（不要使用BeforeXxxAfterXxx ）. 如,一个可以取消的关闭事件可以表示为Clos ing和Close

33、d eve nt. 考虑使用动词来命名事件 2.6大小写敏感 不要岀现必须要大小写敏感支持的名字.组件应该在无论大小写敏感或不敏感的语言中都能使 用。因为 需要大小写敏感的语言不能识别两个相同内容但用大小写区分的名字，所以组件 必须避免这种情况 不要岀现两个只用大小写区分的命名空间，如 n ames pace ee.cum min gs; n ames pace Ee.Cum mings; 不要岀现两个只用大小写区分的参数如 void foo(stn ng a, stri ng A) 不要岀现只用大小写区分的同一命名空间的类型 System.Wi nForms.Point p; System.

34、Wi nForms .P OINT pp; 不要岀现只用大小写区分的同一类型属性。 int Foo get, set; int FOO get, set 不要岀现两个只用大小写区分的方法 void foo(); void Foo(); 3程序注释规范 要使程序易于理解，注释十分重要。在此，提供基本的注释编写规范。 3.1注释编写准则 将注释与注释分隔符用一个空格分开。 不允许给注释加外框。 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。 不再有用的注释要删除。 注释的内容要清楚、明了，含义准确，防止注释二义性。 避免在注释中使用缩写，特别是非常用缩写。 注释应与其描述的

35、代码相近，对代码的注释应放在其上方或右方（对单条语句 的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个 Tab键。程序 段或语句的注释在程序段或语句的上一行。 注释与所描述内容进行同样的缩排。 重要变量必须有注释。 典型算法必须有注释。 在循环和逻辑分支的地方必须写上注释。 避免在一行代码或表达式的中间插入注释。 在代码交付之前，必须删掉临时的或无关的注释。 3.2模块注释 在一个程序模块的开始，应用注释说明模块的名字、功能、开发者和日期和版本变更历史, 如下所示： / /Name: ChargeUser /

36、Function: Charge credits from the user acco unt and save it to the uses acco unt /Author: / Date: / /Cha nge History: / Date Who / /2000-5-1 Author1 In itial creation /2000-5-15 Author2 Add bStatus variable to ide ntify User?ls state /2000-7-3 Authors Add CheckBlackList() to check whether user / is

37、in black list / Author Name Aug. 8, 2000 Changes Made 3.3类的注释 在定义一个类之前，应用“ /”注释说明类的功能、使用方法和特殊的属性，如下所示: / / This class contains the bus in ess facade for the order system. / 精选文库 / The bus in ess facade is used to p rovide a sim plified in terface into the / / order sub systems. / / 23 / sce narios.

38、This class is marked as MarshalByRefObject to support remoted / / /summary public classOrderSystem : MarshalByRefObject 须注意的是，我们要遵从VS.NET对注释的约定，使用summary标记来指定类总体注释的 开始，用/summary标记它的结束。对类的一些注解说明可以放在remarks和/remarks 对中。以后我们可以从这些注解自动得到对代码的说明文档。如下例所示： Duwamish7.Busi nessFacade.OrderSystem Class This cla

39、ss is marked as This class contains the business facade for the order system. The business facade is used to P rovidea sim plifiedinterface into the order sub systems. MarshalByRefObject to support remoted scenarios. Access: P ublic Members Base Classes: MarshalByRefObject Descri ption Fills in the

40、order summary data for an order . The order that is GetOrderSummary being worked on. Up dated OrderData object. This is returned AddOrder to support the remoted scenario (OrderData is a MarshalByValue object). class=System. App licationExce ption The order is null. Add an order and return the transa

41、ction id. The order that is being worked on. The order that has just been added. class=System. App licationExce ption The order is null. Remarks: The business facade is used to p rovide a sim plified interface into the order sub systems. This class is marked as MarshalByRefObject to support remoted

42、scenarios. 3.4类成员方法的注释 在定义类成员方法前，应说明该过程/函数的名字、功能、输入 /输出和版本变更历史，如下 所示： Fills in the order summary data for an order. vp aram n ame=orderrhe order that is being worked on U pdated OrderData object. This is returned to support the remoted sce nario (OrderData is a MarshalByValue object). / / / / / / /

43、/ / / Change History: Who Authorl Author2 / / Changes Made In itial creati on Add bStatus variable to ide ntify User?Y state /Date / 2000-5-1 / 2000-5-15 / P ublic OrderData GetOrderSummaryQrderData order) 在这里“ vparam name= ”和“ v/param”指明方法的参数的描述信 息；“ ”和“ ”对说明了方法返回值的特性。 由这些注解自动得到的说明文档如下所示： Duwamish7

44、.Busi nessFacade.OrderSystem.GetOrderSum mary Fun cti on Fills in the order summary data for an order. The order that is being worked on. Up dated OrderData object. This is returned to support the remoted scenario (OrderData is a MarshalByValue object). Public OrderData GetOrderSummary (OrderData) T

45、ype Name Descri ption The order OrderData order that is being worked on. 精选文库 25 Return Descri ption OrderData Remarks: This is returned to suppo rt the remoted scenario （OrderData is a MarshalByValue object）. 3.5类成员属性、常量、变量的注释 在定义类成员属性前，应描述该属性，如: / / 档案编号 / p ublicStringDonorID; 对于模块级的常量、变量应该象类成员属性

46、一样写注释。 3.6程序注释 在代码实现时，应对其目的和实现的功能进行说明，其要点是： 采用了特殊的语法需要对语法注释； 为实现部分功能需要注释； 不能通过上下文立即明白其功能需要注释。 （1） （2） （3） 如下例所示： P ublic OrderData GetOrderSummaryQrderData order） / / Check precon diti ons / App licati on Assert.CheckC on diti on（o rder != n ull, Order is required, App licati on Assert.Li neNumber）;

47、 / / Calculate subTotal / Decimal subTotal = 0; 4代码书写规范 4.1排版规范 程序块要采用缩进风格编写，在某些情况下，代码需要有适当的缩进，缩进的 空格数为4个。 说明：对于由开发工具自动生成的代码可以有不一致。 相对独立的程序块之间、变量说明之后必须加空行。 示例：如下例子不符合规范。 if (isValid) ./ p rogram code Test t = new Test(); 应如下书写 if (isValid) ./ p rogram code Test t = new Test(); 较长的语句（80字符）要分成多行书写，长表达

48、式要在低优先级操作符处划 分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐, 语句可读。 示例： int test = aaaaaaaaaaaaaa + bbbbbbbbbbbbbbb; 循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达 式要在低优先级操作符处划分新行，操作符放在新行之首。 示例: if (test MAX_TEST_NUMBER) (i MAX_TEST_NUMBER) i+, j+) ./ P rogram code 若方法的参数较长，则要进行适当的划分。 示例： P ublic void TestMethod (stri ng a,

49、stri ng b,stri ng c, stri ng d,stri ng e); 不允许把多个短语句写在一行中，即一行只写一条语句。 示例：如下例子不符合规范。 rect.le ngth = 0;rect.width = 0; 应如下书写 rect.le ngth = 0; rect.width = 0; if、for、do、while、case switch、default 等语句自占一行，且 if、for、do、while 等语句的执行语句部分无论多少都要加括号 。 示例：如下例子不符合规范。 if (user = NULL) retur n; 应如下书写: if (user = NU

50、LL) return; 对齐只使用空格键，不使用 TAB键。 说明：以免用不同的编辑器阅读程序时，因 序布局不整齐。 TAB键所设置的空格数目不同而造成程 方法的开始、结构的定义及循环、 判断等语句中的代码都要采用缩进风格，case 语句下的情况处理语句也要遵从语句缩进要求。 示例: public void TestMethod() p rogram code 精选文库 程序块的分界符（如大括号和）应各独占一行并且位于同一列，同时与引 用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义 以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方

51、式。 示例：如下例子不符合规范。 for (.) ./ p rogram code if (.) ./ P rogram code void TestMethodO ./ p rogram code 应如下书写。 for (.) ./ p rogram code if (.) ./ p rogram code void TestMethodO ./ P rogram code 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、 之后或者前后要加空格。 说明：采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要

52、再留 空格，如果语句已足够清晰则括号内侧（即左括号后面和右括号前面 ）不需要加空格，多 重括号间不必加空格，因为括号已经是最清晰的标志了。 在长语句中，如果需要加的空格非常多，那么应该保持整体清晰， 而在局部不加空格。 给操作符留空格时不要连续留两个以上空格。 27 精选文库 示例： (1)逗号、分号只在后面加空格。 int a, b, c; (2)比较操作符，赋值操作符=、+=,算术操作符+、%,逻辑操作符 a += 2; (3)!、+ flag = !isE mp ty; / i+; a = b A 2; -等单目操作符前后不加空格。 非操作!与内容之间 / +,-与内容之间 (4) if

53、、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明 显。 if (a = b t.DataSource = P ublishers; t.DataField = AuthorlD; / The data bi ndi ng feature is now active. 上面的代码是与下面的程序等效的 TextBox t = new TextBox(); t.DataField = AuthorID; t.DataSource = P ublishers; / The data binding feature is now active. 此外，程序员可以将一

54、个属性设为null,指明这个属性是未赋值的 TextBox t = new TextBox(); t.DataField = AuthorID; t.DataSource = P ublishers; / The data binding feature now active t.DataSource = n ull; / The data bin di ng feature is now in active 并检查数据绑定的状态并在适当的时候 下面的例子演示了如何做到对属性的赋值顺序复关, 自动激活相应的功能. p ublic class TextBox stri ng dataSource

55、; stri ng dataField; boolea n active; p ublic stri ng DataSource get return dataSource; set if (value != dataSource) / Up date active state. SetActive(value!= null dataSource = value; p ublic stri ng DataField get retur n dataField; set if (value != dataField) / Up date active state. SetActive(dataS

56、ource != n ull dataField = value; void SetActive(boolea n value) if (value != active) if (value) Activate。； Text = dataBase.Value(dataField); else Deactivate(); Text =; active = value; / set active only if success void Activate() / open database void Deactivate。 / close database 5.1.1 只读和只写的属性 当在逻辑上

57、要求用户不能改变类的属性时，需要使用只读属性 禁止使用只写属性 5.2事件使用指南 使用Pascal风格来命名事件. 不要使用匈牙利命名法 应该使用raise ”产生”术语来表示产生事件而不是使用fire或“trigger ” 当在文档中描述事件时，应该使用an event was raised而不是an eve nt was fired 或 “ an eve nt was triggered. ” 应考虑用动词来命名一个事件. 事件处理程序应返回 void值.例如: P ublic delegate void MouseEve ntHa ndler(object sen der, Mouse

58、Eve ntArgs e); 因该从System.EventArgs类中派生岀事件处理数据类。例如: p ublic class MouseEve ntArgs : Eve ntArgs 应该假设在事件处理过程中会发生任何事情 （要注意异常处理）. 类应该准备事件处理过程会修改任何的事物，而且需要保证在事件被生成时所有的对象都处 于一个合法的状态.应该考虑使用try/finally程序块在事件产生的地方.由于程序员调用了 call back函数在这个对象上执行操作，就不应该在程序控制返回后对程序状态做任何假设 例如： p ublic class Butt on Butto nClickHa n

59、dler o nClickHa ndler; P rotected void DoClick() Pain tDow n(); / paint butt on in dep ressed state try On Click(); / call event han dler fin ally / window may be deleted in eve nt han dler if (win dowHa ndle != n ull) P ai ntUpO; / paint butt on in nor mal state pr otected virtual void On Click(Cli

60、ckEve nt e) if (on ClickHa ndler != null) on ClickHa ndler(this, e); 5.3方法使用指南 使用Pascal风格来命名事件. 不要使用匈牙利命名法 缺省使用非虚函数的方法 5.3.1 方法重载指南 当一个类中有两个同名的方法可以使用，只不过他们有不同的调用参数时，我们需要方法重 载.（源码网资料下载： ） 当你要在类中提供两个不同的方法而他们的语意相同时，应该使用方法重载. CLS 用重载来实现方法的缺省参数。（缺省参数这种方法无法很好地翻译，因此在通用语言规范 中是不允许的）. int Strin g. In dexOf (S