web应用代码规范 - read

《web应用代码规范 - read》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Web应用代码规范-ReadWeb应用代码规范1WEBAPPLICATION代码规范11.1文档目的21.2命名指南21.2.1基本规则21.2.2命名空间命名指南31.2.3类命名指南31.2.4接口命名指南41.2.5属性类命名指南41.2.6枚举类型命名指南41.2.7字段命名指南41.2.8静态字段命名指南41.2.9参数命名指南41.2.10方法命名指南51.2.11属性命名指南51.2.12事件命名指南51.3数据库设计命名指南51.3.1参考建议51.3.2数据库对象的命名约定61.

2、4代码注释71.4.1XML标记71.4.2类的XML文档注释71.4.3成员的XML文档注释81.4.4方法的XML文档注释81.4.5如何写Changelog91.4.6代码分组101.4.7代码注释的建议101.1文档目的本文用于给开发人员使用C#在.Net平台上编程提供规范指南。*命名指南，开发人员须遵循统一的命名风格与规范。*代码注释，是开发文档中必不可少的部分，文中说明了如何对代码进行注释。*在代码会审阶段，命名风格和代码注释纳入审查的内容。1.2命名指南参考：ms-help://MS

3、.NETFrameworkSDK.CHS/cpgenref/html/cpconnamingguidelines.htm1.2.1基本规则Pascal大小写　　将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如：BackColorCamel大小写　　标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor大写　　标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如：System.IO，Sy

4、stem.Web.UI缩写*不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用GetWindow，而不要使用GetWin。*不要使用计算机领域中未被普遍接受的缩写。*在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用UI作为UserInterface的缩写，用OLAP作为On-lineAnalyticalProcessing的缩写。*在使用缩写时，对于超过两个字符长度的缩写请使用Pascal大小写或Camel大小写。例如，使用HtmlButton或HTMLButton。但是，应当大

5、写仅有两个字符的缩写，如，System.IO，而不是System.Io。*不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字符所组成的缩写请使用Camel大小写，虽然这和单词的标准缩写相冲突。避免冲突*避免使用与常用的.NET框架命名空间重复的类名称。标识符的示例标识符大小写示例类PascalAppDomain枚举类型PascalErrorLevel枚举值PascalFatalError事件PascalValueChange异常类PascalWebException注意总是以Ex

6、ception后缀结尾。只读的静态字段PascalRedValue接口PascalIDisposable注意总是以I前缀开始。方法PascalToString命名空间PascalSystem.Drawing参数CameltypeName属性PascalBackColor受保护的实例字段CamelredValue注意很少使用。属性优于使用受保护的实例字段。公共实例字段PascalRedValue注意很少使用。属性优于使用公共实例字段。1.2.2命名空间命名指南　　命名命名空间时的一般性规则是使用公司

7、名称，后跟技术名称和可选的功能与设计，如下所示。　　CompanyName.TechnologyName[.Feature][.Design]1.2.3类命名指南*使用名词或名词短语命名类。*使用Pascal大小写。*少用缩写。*不要使用类型前缀，如在类名称上对类使用C前缀。例如，使用类名称FileStream，而不是CFileStream。*不要使用下划线字符(_)。*有时候需要提供以字母I开始的类名称，虽然该类不是接口。只要I是作为类名称组成部分的整个单词的第一个字母，这便是适当的。例如，类名

8、称IdentityStore是适当的。*在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException对于从名为Exception的类派生的类是适当的名称，原因是ApplicationException是一种Exception。请在应用该规则时进行合理的判断。例如，Button对于从Control派生的类是适当的名称。尽管按钮是一种控件，但是将Control作为类名称的一部分将使名称不必要地加长。1.2.4接口命名指南