学习资料ASPNET编程规范.docx

学习资料ASPNET编程规范.docx

《学习资料ASPNET编程规范.docx》由会员分享，可在线阅读，更多相关《学习资料ASPNET编程规范.docx（30页珍藏版）》请在冰豆网上搜索。

学习资料ASPNET编程规范

ASP.NET编程规范

Version1.0

目录

第一章　概述4

规范制定原则4

术语定义4

Pascal大小写4

Camel大小写4

文件命名组织4

1.3.1文件命名4

1.3.2文件注释4

第二章代码外观6

2.1列宽6

2.2换行6

2.3缩进6

2.4空行6

2.5空格6

2.6括号-（）7

2.7花括号-{}7

第三章程序注释9

3.4注释概述9

3.2文档型注释9

3.3类c注释10

3.4单行注释10

3.5注释标签10

第四章　申明14

4.7每行声明数14

4.8初始化14

4.9位置14

4.10类和接口的声明15

4.11字段的声明15

第五章　命名规范16

5.7命名概述16

5.8大小写规则16

5.9缩写17

5.10命名空间17

5.11类18

5.12接口18

5.13属性（Attribute）19

5.14枚举（Enum）19

5.15参数19

5.16方法20

5.17属性（property）20

5.18事件21

5.19常量（const）22

5.20字段22

5.21静态字段23

5.22集合24

5.23措词24

第六章　语句25

6.6每行一个语句25

6.2复合语句25

6.3return语句25

6.4if、if-else、ifelse-if语句25

6.4for、foreach语句26

6.5while语句26

6.7.do-while语句27

6.8.switch-case语句27

6.7.try-catch语句27

6.8.using块语句28

6.9.goto语句28

第六章控件命名规则29

7.1命名方法29

7.2主要控件名简写对照表29

第七章其他29

8.1表达式29

8.2类型转换29

附录一:

匈牙利命名法30

第一章　概述

规范制定原则

1方便代码的交流和维护。

2不影响编码的效率，不与大众习惯冲突。

3使代码更美观、阅读更方便。

4使代码的逻辑更清晰、更易于理解。

术语定义

Pascal大小写

将标识符的首字母和后面连接的每个单词的首字母都大写。

可以对三字符或更多字符的标识符使用Pascal大小写。

例如：

BackColor

Camel大小写

标识符的首字母小写，而每个后面连接的单词的首字母都大写。

例如：

backColor

文件命名组织

1.3.1文件命名

1文件名遵从Pascal命名法，无特殊情况，扩展名小写。

2使用统一而又通用的文件扩展名：

C#类.cs

1.3.2文件注释

1在每个文件头必须包含以下注释说明

/*----------------------------------------------------------------

//文件名：

//文件功能描述：

//创建标识：

李轶------20050905------add

//修改标识：

李轶------20050905------update

//----------------------------------------------------------------*/

在所有的代码修改处加上修改标识的注释。

第二章　声明

4.1每行声明数

一行只建议作一个声明，并按字母顺序排列。

如

intlevel;//推荐

intsize;//推荐

intx,y;//不推荐

4.2初始化

建议在变量声明时就对其做初始化。

4.3位置

变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。

如

voidMyMethod（）

{

intint1=0;//beginningofmethodblock

if（condition）

{

intint2=0;//beginningof"if"block

...

}

}

不过也有一个例外

for（inti=0;i

{

...

}

应避免不同层次间的变量重名，如

intcount;

...

voidMyMethod（）

{

if（condition）

{

intcount=0;//避免

...

}

...

}

4.4类和接口的声明

1在方法名与其后的左括号间没有任何空格。

2左花括号“{”出现在声明的下行并与之对齐，单独成行。

3方法间用一个空行隔开。

4.5字段的声明

不要使用是public或protected的实例字段。

如果避免将字段直接公开给开发人员，可以更轻松地对类进行版本控制，原因是在维护二进制兼容性时字段不能被更改为属性。

考虑为字段提供get和set属性访问器，而不是使它们成为公共的。

get和set属性访问器中可执行代码的存在使得可以进行后续改进，如在使用属性或者得到属性更改通知时根据需要创建对象。

下面的代码示例阐释带有get和set属性访问器的私有实例字段的正确使用。

示例：

publicclassControl:

Component

{

privateinthandle;

publicintHandle

{

get

{

returnhandle;

}

}

}

第三章　命名规范

5.1命名概述

1、名称应该说明“什么”而不是“如何”。

例如，可以使用GetNextStudent（），而不是GetNextArrayElement（）。

2、在类属性的名称中包含类名是多余的，如Book.BookTitle。

而是应该使用Book.Title。

3、只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。

4、在变量名中使用互补对，如min/max、begin/end和open/close。

5、布尔变量名应该包含Is，这意味着Yes/No或True/False值，如fileIsFound。

6、在命名状态变量时，避免使用诸如Flag的术语。

状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。

不是使用documentFlag，而是使用更具描述性的名称，如documentFormatType。

（此项只供参考）

7、即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。

仅对于短循环索引使用单字母变量名，如i或j。

5.2大小写规则

大写

标识符中的所有字母都大写。

仅对于由两个或者更少字母组成的标识符使用该约定。

例如：

System.IO

System.Web.UI

下表汇总了大写规则，并提供了不同类型的标识符的示例。

标识符

大小写

示例

类

Pascal

AppDomain

枚举类型

Pascal

ErrorLevel

枚举值

Pascal

FatalError

事件

Pascal

ValueChange

异常类

Pascal

WebException，总是以Exception结尾。

只读的静态字段

Pascal

RedValue

接口

Pascal

IDisposable，注意总是以I前缀开始。

方法

Pascal

ToString

命名空间

Pascal

System.Drawing

属性

Pascal

BackColor

公共实例字段

Pascal

RedValue

注意很少使用。

属性优于使用公共实例字段。

受保护的实例字段

Camel

redValue，注意很少使用。

属性优于使用受保护的实例字段。

私有的实例字段

Camel

redValue

参数

Camel

typeName

方法内的变量

Camel

backColor

5.3缩写

为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则：

1不要将缩写或缩略形式用作标识符名称的组成部分。

例如，使用GetWindow，而不要使用GetWin。

2不要使用计算机领域中未被普遍接受的缩写。

3在适当的时候，使用众所周知的缩写替换冗长的词组名称。

例如，用UI作为UserInterface缩

写，用OLAP作为On-lineAnalyticalProcessing的缩写。

4在使用缩写时，对于超过两个字符长度的缩写请使用Pascal大小写或Camel大小写。

例如，使用HtmlButton或HTMLButton。

但是，应当大写仅有两个字符的缩写，如，System.IO，而不是System.Io。

5不要在标识符或参数名称中使用缩写。

如果必须使用缩写，对于由多于两个字符所组成的缩写请

使用Camel大小写，虽然这和单词的标准缩写相冲突。

5.4命名空间

1、命名命名空间时的一般性规则是使用公司名称，后跟技术名称和可选的功能与设计，如下所示。

CompanyName.TechnologyName[.Feature][.Design]

例如：

namespaceLangchao.Procurement//浪潮公司的采购单管理系统

namespaceLangchao.Procurement.DataRules//浪潮公司的采购单管理系统的业务规则模块

2、命名空间使用Pascal大小写，用逗号分隔开。

3、TechnologyName指的是该项目的英文缩写，或软件名。

4、命名空间和类不能使用同样的名字。

例如，有一个类被命名为Debug后，就不要再使用Debug作为一个名称空间名。

5.5类

1、使用Pascal大小写。

2、用名词或名词短语命名类。

3、使用全称避免缩写，除非缩写已是一种公认的约定，如URL、HTML

4、不要使用类型前缀，如在类名称上对类使用C前缀。

例如，使用类名称FileStream，而不是

CFileStream。

5、不要使用下划线字符（_）。

6、有时候需要提供以字母I开始的类名称，虽然该类不是接口。

只要I是作为类名称组成部分的整个单词的第一个字母，这便是适当的。

例如，类名称IdentityStore是适当的。

在适当的地方，使用复合单词命名派生的类。

派生类名称的第二个部分应当是基类的名称。

例如，ApplicationException对于从名为Exception的类派生的类是适当的名称，原因ApplicationException是一种Exception。

请在应用该规则时进行合理的判断。

例如，Button对于从Control派生的类是适当的名称。

尽管按钮是一种控件，但是将Control作为类名称的一部分将使名称不必要地加长。

publicclassFileStream

publicclassButton

publicclassString

5.6接口

以下规则概述接口的命名指南：

1、用名词或名词短语，或者描述行为的形容词命名接口。

例如，接口名称IComponent使用描述性

名词。

接口名称ICustomAttributeProvider使用名词短语。

名称IPersistable使用形容词。

2、使用Pascal大小写。

3、少用缩写。

4、给接口名称加上字母I前缀，以指示该类型为接口。

在定义类/接口对（其中类是接口的标准实现）时使用相似的名称。

两个名称的区别应该只是接口名称上有字母I前缀。

5、不要使用下划线字符（_）。

6、当类是接口的标准执行时，定义这一对类/接口组合就要使用相似的名称。

两个名称的不同之处

只是接口名前有一个I前缀。

以下是正确命名的接口的示例。

publicinterfaceIServiceProvider

publicinterfaceIFormatable

以下代码示例阐释如何定义IComponent接口及其标准实现Component类。

publicinterfaceIComponent

{

//Implementationcodegoeshere.

}

publicclassComponent:

IComponent

{

//Implementationcodegoeshere.

}

5.7属性（Attribute）

应该总是将后缀Attribute添加到自定义属性类。

以下是正确命名的属性类的示例。

publicclassObsoleteAttribute

{

}

5.8枚举（Enum）

枚举（Enum）值类型从Enum类继承。

以下规则概述枚举的命名指南：

1对于Enum类型和值名称使用Pascal大小写。

2少用缩写。

3不要在Enum类型名称上使用Enum后缀。

4对大多数Enum类型使用单数名称，但是对作为位域的Enum类型使用复数名称。

5总是将FlagsAttribute添加到位域Enum类型。

5.9参数

以下规则概述参数的命名指南：

1、使用描述性参数名称。

参数名称应当具有足够的描述性，以便参数的名称及其类型可用于在大多数情况下确定它的含义。

2、对参数名称使用Camel大小写。

3、使用描述参数的含义的名称，而不要使用描述参数的类型的名称。

少用基于类型的参数名称，仅在适合使用它们的地方使用它们。

4、不要给参数名称加匈牙利语类型表示法的前缀。

以下是正确命名的参数的示例。

TypeGetType（stringtypeName）

stringFormat（stringformat,args（）Asobject）

5.10方法

以下规则概述方法的命名指南：

1使用动词或动词短语命名方法。

2使用Pascal大小写。

3以下是正确命名的方法的实例。

RemoveAll（）

GetCharArray（）

Invoke（）

5.11属性（property）

以下规则概述属性的命名指南：

1使用名词或名词短语命名属性。

2使用Pascal大小写。

3不要使用匈牙利语表示法。

4考虑用与属性的基础类型相同的名称创建属性。

例如，如果声明名为Color的属性，则属性的类型同样应该是Color。

请参阅本主题中后面的示例。

以下代码示例阐释正确的属性命名。

publicclassSampleClass

{

publicColorBackColor

{

//CodeforGetandSetaccessorsgoeshere.

}

}

以下代码示例阐释提供其名称与类型相同的属性。

publicenumColor

{

//InsertcodeforEnumhere.

}

publicclassControl

{

publicColorColor

{

get

{

//Insertcodehere.

}

set

{

//Insertcodehere.

}

}

}

以下代码示例不正确，原因是Color属性是Integer类型的。

publicenumColor

{

//InsertcodeforEnumhere.

}

publicclassControl

{

publicintColor

{

//Insertcodehere

}

}

在不正确的示例中，不可能引用Color枚举的成员。

Color.Xxx将被解释为访问一个成员，

该成员首先获取Color属性（C#中为int类型）的值，然后再访问该值的某个成员（该成

员必须是System.Int32的实例成员）。

5.12事件

以下规则概述事件的命名指南：

1、对事件处理程序名称使用EventHandler后缀。

2、指定两个名为sender和e的参数。

sender参数表示引发事件的对象。

sender参数始

终是object类型的，即使在可以使用更为特定的类型时也如此。

与事件相关联的状态封装

在名为e的事件类的实例中。

对e参数类型使用适当而特定的事件类。

3、用EventArgs后缀命名事件参数类。

4、考虑用动词命名事件。

5、使用动名词（动词的“ing”形式）创建表示事件前的概念的事件名称，用过去式表示事

件后。

例如，可以取消的Close事件应当具有Closing事件和Closed事件。

不要使用

BeforeXxx/AfterXxx命名模式。

6、不要在类型的事件声明上使用前缀或者后缀。

例如，使用Close，而不要使用OnClose。

7、通常情况下，对于可以在派生类中重写的事件，应在类型上提供一个受保护的方法（称为

OnXxx）。

此方法只应具有事件参数e，因为发送方总是类型的实例。

以下示例阐释具有适当名称和参数的事件处理程序。

publicdelegatevoidMouseEventHandler（objectsender,MouseEventArgse）;

以下示例阐释正确命名的事件参数类。

publicclassMouseEventArgs:

EventArgs

{

intx;

inty;

publicMouseEventArgs（intx,inty）

{

this.x=x;

this.y=y;

}

publicintX

{

get

{

returnx;

}

}

publicintY

{

get

{

returny;

}

}

}

5.13常量（const）

以下规则概述常量的命名指南：

所有单词大写，多个单词之间用"_"隔开。

如

publicconststringPAGE_TITLE="Welcome";

5.14字段

以下规则概述字段的命名指南：

1、private、protected使用Camel大小写。

2、public使用Pascal大小写。

3、拼写出字段名称中使用的所有单词。

仅在开发人员一般都能理解时使用缩写。

字段名称不

要使用大写字母。

下面是正确命名的字段的示例。

classSampleClass

{

stringurl;

stringdestinationUrl;

}

4、不要对字段名使用匈牙利语表示法。

好的名称描述语义，而非类型。

5、不要对字段名或静态字段名应用前缀。

具体说来，不要对字段名称应用前缀来区分静态和非静态字段。

例如，应用g_或s_前缀是不正确的。

6、对预定义对象实例使用公共静态只读字段。

如果存在对象的预定义实例，则将它们声明为对象本身的公共静态只读字段。

使用Pascal大小写，原因是字段是公共的。

下面的代码示例阐释公共静态只读字段的正确使用。

publicstructColor

{

publicstaticreadonlyColorRed=newColor（0x0000FF）;

publicColor（intrgb）

{

//Insertcodehere.}

publicColor（byter,byteg,byteb）

{

//Insertcodehere.

}

publicbyteRedValue

{

get

{

returnColor;

}

}

}

5.15静态字段

以下规则概述静态字段的命名指南：

1、使用名词、名词短语或者名词的缩写命名静态字段。

2、使用Pascal大小写。

3、对静态字段名称使用匈牙利语表示法前缀。

4、建议尽可能使用静态属性而不是公共静态字段。

5.16集合

集合是一组组合在一起的类似的类型化对象，如哈希表、查询、堆栈、字典和列表，集合的命名建议用复数。

5.17措词

避免使用与常用的.NET框架命名空间重复的类名称。

例如，不要将以下任何名称用作类名称：

System、Collections、Forms或UI。

有关.NET框架命名空间的列表，请参阅类库。

另外，避免使用和以下关键字冲突的标识符。

AddHandler

AddressOf

Alias

And

Ansi

As

Assembly

Auto

Base

Boolean

ByRef

Byte

ByVal

Call

Case

Catch

CBool

CByte

Cchar

CDate

CDec

CDbl

Char

Cint

Class

CLng

CObj

Const

Cshort

CSng

CStr

CType

Date

Decimal

Declare

Default

Delegate

Dim

Do

Double

Each

Else

ElseIf

End

Enum

Erase

Error

Event

Exit

ExternalSource

False

Finalize

Finally

Float

For

Friend

Function

Get

GetType

Goto

Handles

If

Implements

Imports

In

Inherits

Integer

Interface

Is

Let

Lib

Like

Long

Loop

Me

Mod

Module

MustInherit

MustOverride

MyBase

MyClass

Namespace

New

Next

Not

Nothing

NotInheritable

NotOverridable

Object