.Net开发规范

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.2

2、Camel风格.72.2.3大写风格.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类成员方法的注释.15请预览后下载！3.5类成员属性、常量、变量的注释.163.6程序注释.164.代码书写

3、规范代码书写规范.164.1排版规范.165.类成员使用规范类成员使用规范.205.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标准异常类型

4、.337.2异常的包装 WRAPPING EXCEPTIONS.348.数组使用指南数组使用指南.348.1数组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触发器使用要求.36请预览后下载！1 1概述概述在建设过程中，将涉及到在新的 Visual Studio.NET 以及.NET Framework 平台上的开发工作。同时，设计人员、开发人员和测试

5、人员较多。为了使应用程序的结构和编码风格标准化，便于阅读和理解编码，以提高开发效率和产品的标准化，制订一套开发规范和标准势在必行。此外，好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。希望开发人员严格遵守此套开发规范和标准，并落实到自己的程序中。一组通用目的的编码约定应该定义完成上述目的所必需的、能让程序员自由地创建程序逻辑和功能流程的最小的要求。最小编码约定的目的是使程序易于阅读和理解，从而指导程序员更好地完成开发任务。本规范主要针对使用 Visual Studio.NET 以及.NET Framework 开发的基于 Web 的应用系统。2 2命名命

6、名规范规范2.12.1 指导性原则指导性原则命名是编程的核心。能够对变量和函数/过程进行表意清晰而准确的命名，就能使程序的可读性大大提高，达到不说自明的效果。真正的名称是深入认真思考一个对象的生态环境后才能给出的。程序设计人员只有在充分理解并把握整个系统时，才可能给出真正合适的名字。如果名称选用恰当，一切就显得很自然，各部分关系清晰，意义可以推导而出，阅读程序时可以按常识推理，从而减小程序员对已有程序的阅读和理解困难，提高工作效率，使新程序员能在尽量短的时间内进入角色。以下章节描述了程序命名的一些指导性原则。.1使用正确的大小写风格使用正确的大小写风格为保证良好的程序可读性，对

7、命名的大小写必须按照一致的规定编写，主要包括Pascal 风格和 Camel 风格两种，下面将会有专门的章节进行详细说明。请预览后下载！.2使用描述性英文名称使用描述性英文名称为保证程序的可读性，要采用准确描述其意义的名字。英语是国际通用语言，绝大多数商业类库或函数库代码都是由英语编写的。要与标准接轨，充分利用网上的程序资源，应尽量使用英语命名。.3使用易读的名称使用易读的名称如果不可读或不易读，则不便于讨论和交流。因此我们要尽量使用大众化名称，避免使用不常用的单词。.4尽量避免在名称中使用编码尽量避免在名称中使用编码对名称使用编码就需解码才能理

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

9、 retrieve 和 get，那么，使用你的类从事编程的人就要多费很多精力去理解它们。也就是说，我们应该通过使用一致的名称，创建统一的编程接口，简化学习的难度。.6保持词义的前后一致保持词义的前后一致多数词都有不止一个意思，但在同一个系统中，应始终保持同一个意思。这和前面的原则是相对应的。使用不同的词汇，使人联想不同的接口和/或操作。同样，使用同样的词汇，使人联想相同的接口和/或操作。如果我学过使用 DeviceManager:add(), 我就会期望可以使用 ProtocolManager:add(). 这是根据名称产生的联想，甚至连想到可以使用*Manager:add()

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

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

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

13、r. address_， 同样都是 address, 但仅在语境中才有意义，以下的命名是不可取的：Company. companyAddress_, Customer.customerAddress_。.12不要添加人为的语境不要添加人为的语境不要在类的前面冠以公司名缩写、项目名称缩写或其他标志性前缀。例如，在做知识管理系统时，把员工类命名成 KmsUser。以上命名法是不可取的，这样势必造成代码重复，影响代码的重用。如使用同一个类，则 KmsUser 在其他系统中就显得不和谐了。.13避免名称差别不明显造成混淆避免名称差别不明显造成混淆这个问题源于编写程序

14、仅仅是为了能编译通过或能解译执行。编译和解译程序不允许在同一域内用相同的名字指称两个东西。所以，遇到编译问题时，就随便将其中的一个改变一下。更糟糕的是，原本同一个名称，因拼写错误变成两个名称。这里要说的关键问题是，如果要区分两样不同的东西，一定要保证名称有实质性的差别。例如，若将一个类命名成 Product，另一个类命名成 ProductInfo 或 ProductData, 就会因差别不明显造成混淆。因为 Info 和 Data 没有具体的意思。同理，不要在 OO 编程中使用 Class 或 Object 作为名称的一部分。CustomerObject 和 Customer 有什么区别? N

15、ameString 比 Name 好吗? 难道一个 Name 还会是浮点数或整数不成？特别要强调的是，对于大小写敏感的编程环境，我们不要使用仅有大小写区别的名字。 例如，Customer, customer 不应作为两个名字。2.22.2 大写风格大写风格以下章节描述了不同方式的大写方式.这些术语将在通篇文档中被经常引用..1PascalPascal 风格风格 这种风格大写每个单词的首字母BackColor应在所有由多单词组成的公共描述符中使用这种方式.举例而言,使用 TextColor 就比 Textcolor 或 Text_color 更好.请预览后下载！注意不要大写 “连

16、接词”（一个单词中包含了几个单词，但这个单词本身有自己的意思，如 Checkbook）每个组合单词的首字母。应该将这个单词作为一个单词来考虑，而非几个单词的组合。使用词典决定一个组合词是不是应该作为一个单词来使用。.2CamelCamel 风格风格这种风格除了第一个单词的首字母,其他单词都应大写首字母,如下所示backColor在局部变量参数名或私有类属性名称上使用 camel 风格。 .3大写风格大写风格只在少于两个字母的缩写中使用大写。三个以上字母的缩写都应该使用 PASCAL 风格。举例而言 System.IO System.Web.UI System.C

17、odeDom一个另外的情形是和原有的未管理的标志兼容，而原来常用大写来表示枚举和常量。通常这些标志符不应该暴露给外部。.4大写小结大写小结下表描述了不同类型的描述符该怎么使用大小写类型风格备注ClassPascal 风格 Enumeration valuePascal 风格 Enumeration typePascal 风格 EventPascal 风格 Exception classPascal 风格用后缀 Exception.Read-only static fieldPascal 风格 InterfacePascal 风格用前缀 I.MethodPascal 风格 Nam

18、espacePascal 风格 PropertyPascal 风格 Public instance fieldPascal 风格很少使用，更多使用 properties. 请预览后下载！类型风格备注ClassPascal 风格 Enumeration valuePascal 风格 Enumeration typePascal 风格 EventPascal 风格 Exception classPascal 风格用后缀 Exception.Read-only static fieldPascal 风格 InterfacePascal 风格用前缀 I.MethodPascal 风格 Namespac

19、ePascal 风格 PropertyPascal 风格 Public instance fieldPascal 风格很少使用，更多使用 properties. Protected instance fieldcamel 风格很少使用，更多使用 properties. Parametercamel 风格 Protected instance fieldcamel 风格很少使用，更多使用 properties. Parametercamel 风格 2.32.3 单词选择单词选择不要使用常用的命名空间的名字做类名，举例而言不要使用以下任何单词做类名System Collections Forms

20、UI不要使用和以下关键字冲突的识别符，举例而言，避免这样使用：AddHandlerAddressOfAliasAndAnsiAsAssemblyAutoBaseBooleanByRefByteByValCallCaseCatchCBoolCByteCCharCDateCDecCDblCharCIntClassCLngCObjConstCShortCSngCStrCTypeDateDecimalDeclareDefaultDelegateDimDoDoubleEachElseElseIfEndEnumEraseErrorEventExitExternalSourceFalse FinalizeF

21、inally FloatForFriendFunctionGetGetTypeGoto HandlesIfImplementsImportsInInheritsIntegerInterfaceIsLetLibLikeLongLoopMeModModuleMustInheritMustOverride请预览后下载！MyBaseMyClassNamespaceNewNextNotNothingNotInheritableNotOverridableObjectOnOptionOptionalOrOverloadsOverridableOverridesParamArrayPreservePriva

22、tePropertyProtectedPublicRaiseEventReadOnlyReDimRegionREMRemoveHandlerResumeReturnSelectSetShadowsSharedShortSingleStaticStepStopStringStructureSubSyncLockThenThrowToTrueTryTypeOfUnicodeUntilvolatileWhenWhileWithWithEventsWriteOnlyXorevalextendsinstanceofpackagevar请预览后下载！.1缩写缩写1、请不要砍掉或抽取识别符的

23、部分来作为名称使用。如使用 GetWindow 比 GetWin 更好.2、请不要使用使用不被广泛认可的缩写。 3、只有绝对需要时再使用广为人知的缩写。可以使用 UI 来表示 User Interface，用 OLAP来表示 On-line Analytical Processing.4、当使用缩写时，请使用 Pascal 风格或 camel 风格来表示超过两个或以上单词缩写的构成。如用 HtmlButton 而非 HTMLButton，但不要用 System.Io 来取代 System.IO2.42.4 命名空间命名空间以下模板举例说明了命名空间的命名规则。.Design因此我们希望看到这样

24、如下命名空间:Microsoft.MediaMicrosoft.Media.DesignPowerSoft.PowerBuilder.Math 、避免两个 PUBLISED 的 NAMESPACES 名称一样的可能。使用公司名称或者一个正式分支的名称如用 Microsoft.Office 来表示 Microsoft 提供的 Office Automation Classes。、使用一个稳定的被广泛认可的技术名称作为第二层名称、不要使用组织的结构层次作为命名空间的层次依据、请在 DESIGN-TIME 命名空间前加上.Design 前缀以表示基础命名空间 DESIGN-TIME 特性。如Syst

25、em.Windows.Forms.Design 包含了用来设计System.Windows.Forms 应用程序的的设计器和相关设计类。、使用 PASCAL 风格,把每个逻辑部件用分隔号分开(如 Microsoft.Office.PowerPoint _)如果你的品牌采用了非传统方式的命名,那么就延续的你的品牌的命名方式，就算他和通常的命名空间法则不同。如（NeXT.WebObjects, and ee.cummings）、在适当的地方使用复数命名。例如采用 System.Collections 而非System.Collection。对此例外的是品牌名和缩写。如用 System.IO 而非

26、System.IOs。请预览后下载！、不要让命名空间和类都使用同样的名字。如，当有个类叫 Debug 时就不要使用 Debug来作为命名空间的名字。命名空间结构不需和配件名称结构并行。如，当你决定使用给配件取名叫MyCompany.MyTechnology.dll 时，这并不需要你得让配件中包含一个叫MyCompany.MyTechnology 的命名空间。2.52.5 类和类成员类和类成员.1类的命名指南类的命名指南、使用名词或名词短语命名类。、使用 Pascal 风格、谨慎使用缩写命名类。、不要使用任何类前缀（如 C）、不要使用强调符号。、偶尔可能会出现已 I 作为类名开头

27、的情况，而这个类又不是一个接口类。这种情况下只要第二个字母是小写就可以接受。如 IdentityStore.、建议使用组合词来命名派生类。在此情况下，你应该考虑使用基类名称作为派生类名称的结尾。举例而言，在英语中的”Coffee Cup”是说的一种杯子，而不是一种咖啡。又如 ApplicationException 表示一种例外，而 BooleanSwicth 表示一种Switch,SerializableAtrribute 是一种属性。但对此应该合理的判断，如 Button 是一种Control 虽然 Control 并没有出现在名字中。以下是一些正确的命名的例子public class F

28、ileStream public class Button public class String .2AttributeAttribute 命名指南命名指南 在自定义属性类的后边应该加上 Attribute 作为后缀。请预览后下载！public class ObsoleteAttribute : Attribute .3枚举命名指南枚举命名指南、使用 Pascal 风格来命名枚举类型.、使用 Pascal 风格命名枚举值. 、不要使用简写来命名枚举值.不要在枚举前加前缀(如 adXXX 来命名 ADO enums, rtfXXX 来命名 rich text e

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

30、全适当的.不要使用 reserved 参数。在下个版本中需要更多的数据那么就使用重载。.请不要使用匈牙利命名法来在名称前加前缀Type GetType (string typeName)string Format (string format, object args)请预览后下载！.6方法命名指南方法命名指南使用动词或动词短语来命名方法。使用 Pascal 风格来命名方法.如RemoveAll()GetCharArray()Invoke().7属性命名指南属性命名指南使用名词或名词短语来命名属性使用 Pascal 来命名属性.可以考虑把属性命名和其类型一样。当

31、属性名和一个类型名一样时，那么一定要让这个属性就是这个类型。虽然这听起来有点多余，但这是正确的。以下例子说明了正确的属性命名方法.public enum Color .public class Control public Color Color get . set . 以下是错误的命名public enum Color .public class Control public int Color get . set . 在错误的例子中，Color 枚举的成员不可能被引用到，因为 Color.xxx 的 COLOR 将被解释为 Color（Int）属性，系统将会到 System.Int32 中

32、的实例中去访问成员。..8事件命名指南事件命名指南使用事件 EventHandler 来命名 HANDLER（代理类型）。如 public delegate void MouseEventHandler(object sender, MouseEventArgs e);两个参数取名叫 sender 和 e. sender 参数表示触发时间的对象。sender 都是 object 类型，就算是它可以是更明确的类型。与事件关联的状态被封装到一个事件类的实例中 e 中.对它应该使用适当明确的事件类型。如public delegate void MouseEventHandler(ob

33、ject sender, MouseEvent e);请预览后下载！使用 EventArgs 后缀来命名事件的参数，如 public class MouseEventArgs : EventArgs int x; int y; public MouseEventArgs(int x, int y) this.x = x; this.y = y; public int X get return x; public int Y get return y; 使用现在时态和过去时态来命名有“前”、“后”概念的事件。（不要使用BeforeXxxAfterXxx）.如,一个可以取消的关闭事件可以表示为 C

34、losing 和 Closed event.考虑使用动词来命名事件2.62.6 大小写敏感大小写敏感不要出现必须要大小写敏感支持的名字.组件应该在无论大小写敏感或不敏感的语言中都能使用。因为 需要大小写敏感的语言不能识别两个相同内容但用大小写区分的名字，所以组件必须避免这种情况不要出现两个只用大小写区分的命名空间，如namespace ee.cummings;namespace Ee.Cummings;不要出现两个只用大小写区分的参数如.void foo(string a, string A)不要出现只用大小写区分的同一命名空间的类型System.WinForms.Point p;System

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

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

37、/Function:Charge credits from the user account and save it to the users account/Author: Author Name/ Date:Aug. 8, 2000/-/Change History:/ DateWhoChanges Made/-/2000-5-1 Author1Initial creation请预览后下载！/2000-5-15Author2Add bStatus variable to identify Users state请预览后下载！/2000-7-3 Author3Add CheckBlackLi

38、st() to check whether user /is in black list/-3.33.3 类的注释类的注释在定义一个类之前，应用“/”注释说明类的功能、使用方法和特殊的属性，如下所示：/ / This class contains the business facade for the order system. / / The business facade is used to provide a simplified interface into the / order sub systems. / / / / This class is marked as Marsha

39、lByRefObject to support remoted scenarios. / / public class OrderSystem : MarshalByRefObject 须注意的是，我们要遵从 VS.NET 对注释的约定，使用标记来指定类总体注释的开始，用标记它的结束。对类的一些注解说明可以放在 和 对中。以后我们可以从这些注解自动得到对代码的说明文档。如下例所示：Duwamish7.BusinessFacade.OrderSystem ClassThis class contains the business facade for the order system. The

40、business facade is used to provide a simplified interface into the order sub systems. This class is marked as MarshalByRefObject to support remoted scenarios. Access: PublicBase Classes: MarshalByRefObject MembersDescription GetOrderSummaryFills in the order summary data for an order. The order that

41、 is being worked on. Updated OrderData object. This is returned to support the remoted scenario (OrderData is a MarshalByValue object). class=System. ApplicationException The order is null. 请预览后下载！ AddOrderAdd an order and return the transaction id. The order that is being worked on. The order that

42、has just been added. class=System. ApplicationException The order is null. Remarks:The business facade is used to provide a simplified interface into the order sub systems. This class is marked as MarshalByRefObject to support remoted scenarios. 3.43.4 类成员方法的注释类成员方法的注释在定义类成员方法前，应说明该过程/函数的名字、功能、输入/输出

43、和版本变更历史，如下所示：/ / Fills in the order summary data for an order./ The order that is being worked on./ Updated OrderData object. / / This is returned to support the remoted scenario (OrderData is a / MarshalByValue object)./ / / /-/ Change History:/DateWhoChanges Made/ 2000-5-1Author1Initial creation/

44、2000-5-15Author2Add bStatus variable to identify Users state/-public OrderData GetOrderSummary(OrderData order)在这里“param name=” 和“”指明方法的参数的描述信息；“” 和“”对说明了方法返回值的特性。由这些注解自动得到的说明文档如下所示：请预览后下载！Duwamish7.BusinessFacade.OrderSystem.GetOrderSummary FunctionFills in the order summary data for an order. The

45、order that is being worked on. Updated OrderData object. This is returned to support the remoted scenario (OrderData is a MarshalByValue object). Public OrderData GetOrderSummary (OrderData) TypeNameDescription OrderDataorderThe order that is being worked on. ReturnDescription OrderData Remarks:This

46、 is returned to support the remoted scenario (OrderData is a MarshalByValue object). 3.53.5 类成员属性、常量、变量的注释类成员属性、常量、变量的注释在定义类成员属性前，应描述该属性，如：/ / 档案编号/ publicStringDonorID;对于模块级的常量、变量应该象类成员属性一样写注释。3.63.6 程序注释程序注释在代码实现时，应对其目的和实现的功能进行说明，其要点是：（1）采用了特殊的语法需要对语法注释；（2）为实现部分功能需要注释；（3）不能通过上下文立即明白其功能需要注释。如下例所示：p

47、ublic OrderData GetOrderSummary(OrderData order)/ Check preconditions/ApplicationAssert.CheckCondition(order != null, Order is required, ApplicationAssert.LineNumber);/ Calculate subTotal/请预览后下载！Decimal subTotal = 0;请预览后下载！4 4代码书写规范代码书写规范4.14.1 排版规范排版规范程序块要采用缩进风格编写，在某些情况下，代码需要有适当的缩进，缩进的空格数为 4 个。说明：对

48、于由开发工具自动生成的代码可以有不一致。相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if (isValid) . / program codeTest t = new Test();应如下书写if (isValid) . / program codeTest t = new Test();较长的语句（80 字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：int test = aaaaaaaaaaaaaa + bbbbbbbbbbbbbbb;循环、判断等语句中若有较长的表达式或语

49、句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。示例：if (test MAX_TEST_NUMBER) & (IsValidMethod(testBool) . / program code请预览后下载！for (i = 0, j = 0; (i MAX_TEST_NUMBER) & (j test.length); i+, j+) . / program code若方法的参数较长，则要进行适当的划分。示例：public void TestMethod (string a,string b,string c,string d,string e);不允许把多个

50、短语句写在一行中，即一行只写一条语句。示例：如下例子不符合规范。rect.length = 0; rect.width = 0;应如下书写rect.length = 0;rect.width = 0;if、for、do、while、case、switch、default 等语句自占一行，且if、for、do、while 等语句的执行语句部分无论多少都要加括号。 示例：如下例子不符合规范。if (user = NULL) return;应如下书写：if (user = NULL) return;对齐只使用空格键，不使用 TAB 键。说明：以免用不同的编辑器阅读程序时，因 TAB 键所设置的空格数

51、目不同而造成程序布局不整齐。方法的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case 语句下的情况处理语句也要遵从语句缩进要求。示例：public void TestMethod()./ program code请预览后下载！程序块的分界符（如大括号和 ）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方式。示例：如下例子不符合规范。for (.) . / program codeif (.) . / program codevo

52、id TestMethod() . / program code应如下书写。for (.) . / program codeif (.) . / program codevoid TestMethod() . / program code在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为括号已经是最清晰的标志了。在长语句中，如果

53、需要加的空格非常多，那么应该保持整体清晰，而在局部不加空请预览后下载！格。给操作符留空格时不要连续留两个以上空格。请预览后下载！示例：(1) 逗号、分号只在后面加空格。int a, b, c; (2)比较操作符, 赋值操作符=、 +=，算术操作符+、%，逻辑操作符&、&，位操作符= VALUE) a = b + c;a += 2;a = b 2;(3)!、+、-等单目操作符前后不加空格。flag = !isEmpty; / 非操作!与内容之间i+; / +,-与内容之间 (4) if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、明显。if (a =

54、b & c d)一行程序以小于 80 字符为宜，不要写得过长。成员比较多、代码量较大的类中，为了使代码更容易阅读，应适当使用#region#end region 将同类型的代码加以分隔显示或隐藏。示例：#region 属性. / program code#endregion#region 私有方法. / program code#endregion5 5类成员类成员使用规范使用规范5.15.1 属性使用指南属性使用指南使用 Pascal 风格来命名属性public class Foo public Color BackColor 不要使用匈牙利命名法. 请预览后下载！建议不要使用相同的类的属性

55、名字和类型名字. 将一个类的属性名定义成与某个类型(Type)的名字相同会在某些编程语言中引起二义性. 最好避免这种二义性除非由非常正当的理由去这么做。 例如: System.Windows.Forms 类有一个 Icon 属性， 虽然也有一个 Icon 类 但由于 Form.Icon 这个名字比 Form.FormIcon 或 Form.DisplayIcon 这样的类属性名更容易理解，所以我们仍采用 Icon 属性名. 但是在 System.WinForms. UI.Control 类中有一个颜色属性. 由于已经有了一个 Color 类, 这个类的颜色属性就被命名为 BackgroundC

56、olor. 这是一个更有意义的命名且与已经存在的类的名字不冲突. 当对一个类中属性作赋值操作时发生了异常(Exception)时，一定要保证这个属性中还保留着以前保存的属性值。避免这个属性的内容处于不确定状态. 必须允许类的属性可以以任意的顺序赋值. 属性与其他属性间应该是没有状态关系的.通常情况下只有当程序对一组属性作了赋值之后，这个对象的某个功能才会被激活，或者只有当这个对象在一些正确的状态下, 这个功能才会起作用. 而且当对象进入此状态时, 这个功能会被自动激活而无需任何其他的显示(Implicit)调用.例如一个 TextBox 有两个相关的属性: DataSource 和 DataF

57、ield. DataSource 指明了数据表名, 而 DataField 指明了相应的类属性名. 一旦这两个属性被指明后, 这个控件就会把数据表中相应的数据取出赋给这个控件的 Text 属性. 下面的例子演示了我们可以以任意的顺序设置控件的属性.TextBox t = new TextBox();t.DataSource = Publishers;t.DataField = AuthorID;/ The data binding feature is now active.上面的代码是与下面的程序等效的.TextBox t = new TextBox();t.DataField = Auth

58、orID;t.DataSource = Publishers;/ The data binding feature is now active.此外, 程序员可以将一个属性设为 null, 指明这个属性是未赋值的.TextBox t = new TextBox();t.DataField = AuthorID;t.DataSource = Publishers;/ The data binding feature now active t.DataSource = null;/ The data binding feature is now inactive下面的例子演示了如何做到对属性的赋值

59、顺序复关，并检查数据绑定的状态并在适当的时候自动激活相应的功能. public class TextBox string dataSource; string dataField; boolean active; 请预览后下载！ public string DataSource get return dataSource; set if (value != dataSource) / Update active state. SetActive(value!= null & dataField != null); dataSource = value; public string DataFi

60、eld get return dataField; set if (value != dataField) / Update active state. SetActive(dataSource != null & dataField != null); dataField = value; void SetActive(boolean value) if (value != active) if (value) Activate(); Text = dataBase.Value(dataField); else Deactivate(); Text = ; active = value; /