.NET设计规范 武汉无线飞翔科技有限公司
.NET设计规范 1 命名规范
1.1 大小写约定
PascalCasing 将标识符的首字母和后面连接的每个单词的首字母都大写。 可以对三字符或更多字符的 标识符使用 Pascal 大小写。例如: BackColor camelCasing 标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如: backColor 对于由多个单词组成的所有公共成员、类ss型及命名空间名称,要使用 Pascal 大小写。 对参数名称使用大小写混合。 下表汇总了标识符的大小写规则,并提供了不同类型标识符的示例。 表 不同类型的标识符的大小写规则
大小写方式 示例
Pascal AppDomain
Pascal ErrorLevel
Pascal FatalError
Pascal ValueChanged
Pascal WebException
Pascal RedValue
Pascal IDisposable
Pascal ToString
Pascal System.Drawing
Camel typeName
Pascal BackColor
标识符 类 枚举类型 枚举值 事件 异常类 只读的静态字段 接口 方法 命名空间 参数 属性
首字母缩写词与单词缩写 首字母缩写词是由一个短语的首字母组成的,而单词缩写则仅仅把一个单词的长度变 短。 要把两个字母的首字母缩写词全部大写,除非他是camelCasing风格的参数名的第一个单 词。 System.IO 第 1 页 共 51 页
.NET设计规范 public void StartIO(Stream ioStream)
武汉无线飞翔科技有限公司
要把由三个或三个以上字母组成的首字母缩写词的第一个字母大写。只有第一个字母大写, 除非首字母缩写词是camelCasing风格的标识符的第一个单词。 System.Xml public void ProcessHtmlTag(string htmlTag) 在涉及大小写时,大多数复合词术语要作为单个单词处理。 不要把所谓闭合形式的复合词中每个单词的首字母大写。 下表列出一些常用的复合词和常用术语的大小写。 表 常用的复合词和
常用术语的大小写及拼写
Camel Not
bitFlag Bitflag
callback CallBack
canceled Cancelled
doNot Dont
dmail EMail
dndpoint EndPoint
fileName Filename
gridline GridLine
hashtable HashTable
id ID
indexes Indices
logOff LogOut
logOn LogIn
metadata MetaData, metaData
multipanel MultiPanel
multiview MultiView
namespace NameSpace
ok OK
pi PI
placeholder PlaceHolder
signIn SignOn
signOut SignOff
sql SQL
userName Username
whiteSpace Whitespace
writable Writeable
Pascal BitFlag Callback Canceled DoNot Email Endpoint FileName Gridline Hashtable Id Indexes LogOff LogOn Metadata Multipanel Multiview Namespace Ok Pi Placeholder SignIn SignOut Sql UserName WhiteSpace Writable
第 2 页 共 51 页
.
NET设计规范 武汉无线飞翔科技有限公司
1.2 通用命名约定
通用命名约定讨论的是如何为库元素选择最适当的名称。这些准则适用于所有标识符。 后面各节讨论特定元素(如命名空间或属性)的命名。 选择名称 1.选择易读的标识符名称。例如,英文属性名称 HorizontalAlignment 比 AlignmentHorizontal 更具可读性。可读性比简洁性更重要。属性名称 CanScrollHorizontally 比 ScrollableX(指 X 轴,但意义不明确)更好。 2.不要使用下划线、连字符或任何其他非字母数字字符。 3.不要使用匈牙利表示法。 匈牙利表示法是在标识符中使用一个前缀对参数的某些元数 据进行编码,如标识符的数据类型。 4.避免使用与常用编程语言的关键字冲突的标识符。虽然符合 CLS 的语言必须提供将 关键字用作普通字的方法, 最佳做法不要求强制开发人员了解如何实现。 对于大多数编程语 言,语言参考
文档都会提供语言所使用的关键字
列表。 缩写和首字母缩写词 通常,不应使用缩写或首字母缩写词。这类名称的可读性较差。同样,要确定某个首字 母缩写词是否已受到广泛认可也是很困难的。 不要将缩写或缩略形式用作标识符名称的组成部分。例如,使用 OnButtonClick 而不 要使用 OnBtn