基本命名约定

基本命名约定

基本命名约定

 

说明:

Pascal:每个单词首字母大写。

Camel:第一个单词首字母小写,余下的单词首字母大写。

缩写:两个字母的缩写,Pascal命名法两个字母都大写,Camel命名法,如果两个缩写字母是首单词,两个字母都小写,否则按照常规来处理。两个以上字母的缩写都按照常规处理。

 

基本规则:

Pascal或者Camel方式。

不要把变量的数据类型作为变量名称的前缀或者后缀(GUI控件命名除外)。

不要滥用缩写,除非缩写形式为大家所公认。

不要定义依赖字母的大小写才能区别的名称。比如myValuemyvalue。属姓名和属性依赖的私有变量除外比如string MyValue {get {return myValue;}}

名称中不要使用下划线_(类的私有成员变量可以以下划线_作为前缀)。

名称中涉及数据类型时,使用CLR的标准类型名称。比如ToInt32不要用Tolong

不要把易混淆的数字和字母放在一起。比如

bool  b001 = (lo == l0) ? (I1 == 11) : (lOl != 101);

 

类:

用名词或者名词短语来命名类,结构。

不要在类名或结构名前加类似class之类的前缀或者后缀(特殊类型的类除外,比如Attribute)

 

Attribute

Attribute类类名加Attribute后缀。

 

Exception

Exception类类名加Exception后缀。

 

枚举

枚举名称不要加Enum前缀或者后缀。

枚举名用单数形式,不要用复数形式。

 

接口

接口名加I前缀。

 

事件,委派

如果delegate用来定义事件,加EventHandler后缀。

如果delegate用来定义callback方法,加Callback 后缀(实际的callback方法不要加Callback后缀)。

用动词命名事件,不要加Event后缀或者前缀

inged后缀来表示先后概念,不要用beforeafterbeginend模式。

事件触发函数用加On前缀.

 

总结

  Type

Case

Notes

Example

Class / Struct

Pascal

 

HttpContext

Interface

Pascal

加前缀I

IDataAdapter

Enum values

Pascal

 

CommandType

Enum type

Pascal

 

CommandType.Text

Events

Pascal

 

SelectedIndexChanged

Exception

Pascal

加后缀Exception

ArgumentException

public Fields

Pascal

 

Int32.MaxValue

Methods

Pascal

 

ToString

Namespace

Pascal

 

System.Xml

Property

Pascal

 

BackColor

Protected/private Fields

Camel

 

myVariable

Parameters

Camel

 

cmdText

 

  Thursday, April 15, 2004 8:28 PM

评论

# 回复: 基本命名约定 4/16/2004 12:09 PM gcs925

这是msdn类库设计指南的精简版吧,我最近也在整理相关的资料

# 回复: 基本命名约定 4/16/2004 1:00 PM microhelper

这快内容大部分来自msdn类库设计指南

posted on 2004-07-20 09:48  太阳黑子  阅读(766)  评论(0编辑  收藏  举报

导航