与其他命名准则一样,为命名空间命名的目的是为了让使用该框架的程序员能够通过名称快速了解命名空间所涉及的内容。 以下模板指定了为命名空间命名的一般规则:
<Company>.(<Product>|<Technology>)[.<Feature>][.<Subnamespace>]
示例如下:
Fabrikam.Math
Litware.Security
✓ 务必 使用一个公司名作为命名空间的前缀,以防止不同公司的命名空间具有相同的名称。
✓ 务必在命名空间名称的第二级名称中使用稳定的、与版本无关的产品名称。
X 不要使用企业组织的层次结构作为命名空间层次结构中名称的基础,因为公司内的群组名称往往是短期的。应围绕相关技术的群组来组织命名空间的层次结构。 组织周围的相关技术的组的命名空间的层次结构。
✓ 务必使用 PascalCasing,并使用句点分隔命名空间组件(例如,Microsoft.Office.PowerPoint)。 如果品牌使用非传统的大小写形式,则应遵循由品牌定义的大小写,即使与通常的命名空间大小写不符也是如此。
✓ 考虑在适当时使用复数形式的命名空间名称。
例如,使用 System.Collections 而不是 System.Collection。 但此规则不适用于品牌名称和首字母缩写词。 例如,使用 System.IO 而不是 System.IOs。
X 不要对命名空间和该命名空间中的类型使用相同的名称。
例如,如果将命名空间命名为 Debug,就不应在该命名空间中提供一个名为 Debug 的类。 某些编译器要求这些类型为完全限定类型。
命名空间和类型名称冲突
X 不要引入泛型类型名称,如 Element、Node、Log 和 Message 等。
没有这样做将导致类型名称冲突共同方案很有可能。 一般情况下,这样做很可能会导致类型名称冲突。应限定泛型类型名称(FormElement、XmlNode、EventLog、SoapMessage)。
针对不同类别的命名空间,存在避免类型名称冲突的特定准则。
-
应用程序模型命名空间
属于同一应用程序模型的命名空间经常一起使用,但它们几乎从不与其他应用程序模型的命名空间一起使用。 例如,xref:System.Windows.Forms?displayProperty=nameWithType 命名空间很少与 xref:System.Web.UI?displayProperty=nameWithType 命名空间一起使用。以下是一个常见的应用程序模型命名空间组的列表: 下面是已知的应用程序模型命名空间组的列表:
System.Windows*
System.Web.UI*X 不要在单个应用程序模型中为名称空间中的类型指定相同的名称。
例如,不要在 xref:System.Web.UI.Adapters?displayProperty=nameWithType 命名空间中添加名为
Page的类型,因为 xref:System.Web.UI?displayProperty=nameWithType 命名空间已包含名为Page的类型。 -
基础结构命名空间
该组包含在开发常见应用程序期间鲜少导入的命名空间。 例如,
.Design命名空间主要用于开发编程工具。 避免与这些命名空间中的类型发生冲突并不重要。 -
核心命名空间
核心命名空间包括所有
System命名空间,不包括应用程序模型命名空间和基础结构命名空间。 核心命名空间包括System、System.IO、System.Xml和System.Net等。X 不要指定与核心命名空间中任何类型相冲突的类型名称。
例如,永远不要将
Stream用作类型名称。 它会与十分常用的类型 xref:System.IO.Stream?displayProperty=nameWithType 相冲突。 -
技术命名空间组
此类别包括前两个命名空间节点一致 (
(<Company>.<Technology>*) 的所有命名空间,例如Microsoft.Build.Utilities和Microsoft.Build.Tasks。 属于同一单一技术的类型之间不能相互冲突,这一点很重要。X 不要指定与单一技术中任何其他类型相冲突的类型名称。
X 不要让技术命名空间和应用程序模型命名空间中的类型之间产生类型名称冲突(除非不打算将该技术与该应用程序模型一起使用)。
部分版权 © 2005, 2009 Microsoft Corporation。保留所有权利。
经 Pearson Education, Inc 授权,转载自框架设计准则:可重用的 .NET 库的约定、习惯用语和模式,第 2 版 作者:Krzysztof Cwalina 和 Brad Abrams,由 Addison Wesley Professional 于 2008 年 10 月 22 日印发,作为 Microsoft Windows 开发系列的一部分。
请参阅
历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 KrzysztofCwalina)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
