.NET设计规范(二) 命名规范

第2章 命名规范

2.1. 大小写约定

2.1.1. 标识符的大小写规则

ü 用PascalCasing命名多个单词构成的命名空间、类型以及成员的名字。

例如：使用TextColor而不使用Textcolor，单个单词(Button)的首字母大写，当一个单词为复合词(endpoint)作为一个单词，只有第一字母大写。

ü 用camelCasing命名参数的名字。

ü 不同类型标识符的大小写规则，如下表：

标识符	命名法	例子
命名空间	Pascal	nameSpace System.Scurity{...}
类型	Pascal	public class StreamReader{...}
接口	Pascal	public interface IEnumerable{...}
方法	Pascal	public class Object{ public virtual string Tostring();}
属性	Pascal	public class String{ public int Length {get;}}
事件	Pascal	public class Process{ public event EventHandler Exited;}
字段(静态)	Pascal	public class MessageQueue{ public static readonly TimeSpan InfiniteTimeout;}
枚举值	Pascal	FileMode{Append,...}
参数	Camel	public class Convert{ public static int ToInt32 (string value);}

2.1.2. 缩写词首字母的大小写

ü 要把缩写词首字母为两个字母全部大写，当是camelCasing风格的参数名的作为第一单词来使用。

例如：

System.IO

Public void StartIO(Stream ioStream)

ü 把缩写词首字母为三个或三个以上字母第一字母大写，当是camelCasing风格的标识符作为第一单词来命名。

例如：

System.Xml

Public void processHtmlTag(string htmlTag)

ü 不要把camelCasing风格的标识符头部的任何首字母缩写词的任何字母大写，无论首字母缩写词的长度是多少。

2.1.3. 复合词和常用术语的大小写

ü 在涉及大小写时，大多数复合词术语要作为单个单词处理。

ü 不要把闭合形式的复合词中每个单词的首字母大写。

ü 常用的复合词和常用术语的大小写及拼写。如下表：

Pascal	Camel	Not
BitFlag	bitFlag	Bitflag
Callback	callback	CallBack
Canceled	canceled	Cancelled
DoNot	doNot	dont
Email	email	EMail
Endpoint	endpoint	EndPoint
FileName	fileName	Filename
Gridline	gridline	GridLine
Hashtable	hashtable	HashTable
Id	id	ID
Indexes	indexes	Indices
LogOff	logOff	LogOut
LogOn	logOn	LogIn
Metadata	metadata	MetaData,metaData
Multipanel	multipanel	MultiPanel
Multiview	multiview	MultiView
Namespace	namespace	NameSpace
Ok	ok	OK
Pi	pi	PI
Placehoder	placehoder	PlaceHoder
Signln	signln	SignOn
SignOut	signOut	SignOff
UserName	userName	Username
WhiteSpace	whiteSpace	Whitespace
Writable	writable	Writeable

2.1.4. 是否区分大小写

ü 任何外部可访问的API不应该仅通过大小写来区分位于同一个上下文中的两个名字。

ü 区分大小写只有一条规范：不要以为所有的编程语言都是区分大小写的，实际情况并非如此。不应该仅仅通过大小写来区分名字。

2.2. 通用命名的约定

2.2.1. 单词的选择

ü 为标识符选择易于阅读的名字。

ü 要更看重可读性，而不是更看重简短性。如属性名CanScrollHorizontally要胜过ScrollableX。

û 不要使用下划线、连字符以及其他任何既非字母也非数字的字符。

û 不要使用匈牙利命名法。

û 避免使用与广泛使用的编程语言的关键字有冲突的标识符。

2.2.2. 使用单词缩写和首字母缩写词

û 不要使用缩写词和缩约词作为标识符名字的一部分。

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

û 不要使用未被广泛接受的首字母缩写词，即使是被广泛接受的首字母缩写词，也只应该在必需的时候才使用。

例如：UI用来表示User Interface，HTML用来表示Hypertext Markup Language。虽然

许多框架设计师认为一些新近的首字母缩写词很快就会被广泛接受，但在框架的标识

符中使用它们仍是不好的做法。

2.2.3. 避免使用语言特有的名字

ü 要给类型名使用语义上有意义的名字，而不要使用语言特有的关键字。

例如：GetLength这个名字比GetInt要好。

ü 要使用CLR的通用类型名，而不要使用语言特有的别名——如果除了类型之外，标识符没有其他的语义。

例如：一个把类型转换为System. Int64的方法应该被命名为ToInt64，而不是ToLong

（因为System. Int64是CLR类型名，它对应于C#特有的别名long）。

ü 语言特有的类型名及对应的CLR类型名，如下表：

C#	Visual Basic	C++	CLR
sbyte	SByte	margin: 0cm 0cm 0p 分享到： DIY 新浪微博Android客户端 ----用Androi ... | UTF-8的BOM头 2011-03-26 18:35 浏览 926 评论(0) 查看更多 相关推荐 .NET设计规范（完整版） .NET设计规范是软件开发过程中非常重要的指导原则，它旨在提高代码的质量、可读性、可维护性和可扩展性。这份完整版的规范包含了多个方面的内容，涵盖了从命名约定到复杂设计模式的使用，以下是其中的一些关键知识点... .NET设计规范约定 惯用法与模式 .NET设计规范：约定、惯用法与模式（第2版）克瓦林纳 2/5 .NET 设计规范 约定、惯用法与模式 第2版 克瓦林纳 定 价：69.00元 作　者：（美）克瓦林纳　等著，葛子昂　译 出 版 社：人民邮电出版社 出版时间：... .NET设计规范：约定、惯用法与模式（第2版）1/5 .NET设计规范：约定、惯用法与模式（第2版） 1/5 .NET 设计规范 约定、惯用法与模式 第2版 克瓦林纳 定 价：69.00元 作　者：（美）克瓦林纳　等著，葛子昂　译 出 版 社：人民邮电出版社 出版时间：2010-5-1 页　... .NET设计规范：约定、惯用法与模式（第2版）克瓦林纳 3/5 .NET设计规范：约定、惯用法与模式（第2版）克瓦林纳 3/5 .NET 设计规范 约定、惯用法与模式 第2版 克瓦林纳 定 价：69.00元 作　者：（美）克瓦林纳　等著，葛子昂　译 出 版 社：人民邮电出版社 出版时间：2010-... .net设计规范 《.NET设计规范》是一本深入探讨.NET平台开发中最佳实践和设计原则的重要参考资料。这本书旨在提高.NET开发者们的代码质量，提升软件的可维护性、可扩展性和可重用性。通过对.NET框架的设计规范进行详细解读，我们... .net设计规范-之命名规范 .Net设计规范是指导开发者编写高质量、易维护代码的重要准则，其中命名规范是确保代码可读性和团队协作效率的关键部分。本文将深入探讨.Net设计规范中的命名规则，帮助开发者遵循最佳实践，提高代码质量。 首先，... .NET设计规范 .NET设计规范是指导.NET开发者遵循的一系列最佳实践和原则，旨在提高代码的可读性、可维护性和可扩展性。这些规范涵盖了设计模式、命名规则、编码风格等多个方面，是专业.NET开发团队不可或缺的参考指南。 一、设计... .NET设计规范 .NET编程 .NET约定 惯用法与模式 .NET设计规范是软件开发中的一套重要指导原则，它旨在提高代码质量、可维护性和团队间的协作效率。本文将深入探讨.NET设计规范、编程实践、约定以及惯用法与模式，帮助开发者更好地理解和遵循这些原则。 一、设计... 《.NET设计规范：约定、惯用法与模式》(第2版) 中文版 （免费） 《.NET设计规范：约定、惯用法与模式》(第2版)是一本深入探讨.NET框架编程中最佳实践和设计原则的专业书籍。本书聚焦于.NET框架中的C#语言，并为开发者提供了大量的实用建议和指南，帮助他们编写高质量、可维护的... .NET设计规范：约定、惯用法与模式.pdf 《.NET设计规范：约定、惯用法与模式》是一本深入探讨.NET平台开发中最佳实践的权威指南。这本书旨在帮助开发者遵循一套统一的设计规则，提高代码质量，增强软件的可读性、可维护性和可扩展性。书中涵盖了一系列关键... .net 设计规范及例子 《.NET设计规范及其应用实例解析》 在软件开发领域，设计规范是保证代码质量、可维护性和团队协作效率的重要工具。针对.NET平台，有一套详细的.NET设计规范，旨在指导开发者编写出高效、清晰且易于扩展的代码。本文... .NET 开发命名规范 .NET开发命名规范是编程实践中的一项重要规范，它确保代码的可读性、可维护性和团队协作的效率。本文将详细阐述C#、ADO.NET以及其他.NET框架下的命名规则，帮助开发者遵循一致的编码风格。 1. 编写目的 命名规范的... .Net编码规范(Microsoft) 《.Net编码规范(Microsoft)》是一份详细...以上仅为.NET编码规范的部分内容，完整的规范还包括错误处理、注释规范、命名约定、接口设计等多个方面。遵循这些规范将有助于创建出高质量、易于理解和维护的C#应用程序。 ASP.NET 设计 规范 **ASP.NET设计规范详解** ASP.NET是微软推出的一种用于构建Web应用程序的开发框架，它基于.NET Framework或.NET Core，提供了一整套强大的工具和服务，帮助开发者高效地创建动态、交互式的网页应用。本文将深入探讨... .NET设计规范 .NET约定 惯用法与模式 《.NET设计规范 .NET约定 惯用法与模式》是.NET开发者不可或缺的重要参考资料，它涵盖了编程实践中的一系列最佳实践、约定以及模式，旨在提升代码质量和可维护性。这份资料深入探讨了如何遵循.NET框架的设计原则，以... .NET设计规范pdf文档 .NET设计规范是面向开发人员的一份重要指南，旨在提高代码质量、增强软件可维护性和团队协作效率。这份规范涵盖了多个方面，包括命名规则、代码结构、设计模式、异常处理、性能优化等。以下是对这些关键知识点的详细... .NET设计规范：约定、惯用法与模式（第2版）克瓦林纳 5/5 .NET设计规范：约定、惯用法与模式（第2版）克瓦林纳 5/5 .NET 设计规范 约定、惯用法与模式 第2版 克瓦林纳 定 价：69.00元 作　者：（美）克瓦林纳　等著，葛子昂　译 出 版 社：人民邮电出版社 出版时间：2010-... Asp.net编程规范 #### 三、方法、函数命名规范 方法和函数命名遵循驼峰命名法，即除了第一个单词首字母小写外，其余每个单词首字母均大写。示例如下： - 添加员工：`addEmployee()` - 删除员工信息：`deleteEmployeeInformation()` ... .NET开发规范 首先，命名规范在编程中占据核心地位，好的命名可以显著提升代码的可读性。命名应使用正确的大小写风格，例如Pascal风格（每个单词的首字母大写）和Camel风格（除第一个单词外，每个单词的首字母大写），并保持一致... .NET设计规范：约定、惯用法与模式（第2版）克瓦林纳 4/5 .NET设计规范：约定、惯用法与模式（第2版）克瓦林纳 4/5 .NET 设计规范 约定、惯用法与模式 第2版 克瓦林纳 定 价：69.00元 作　者：（美）克瓦林纳　等著，葛子昂　译 出 版 社：人民邮电出版社 出版时间：2010-... Global site tag (gtag.js) - Google Analytics