Microsoft-C#编码规范.doc

鸣谢

本文档的每一章节都应该感谢 Dan Ruder 微软 。 对本文档进行了斟字

酌句的查阅，并根据其  余年的编程经验提供了大量的珍贵评论 。我很荣幸能与他共事。

我同样感谢微软的四位经理，感谢他们对该项目的一贯支持。他们是 Vivian Luo，Allen Ding，Felix Wu和

Mei Liang。

示例代码库项目组 ，以不断充实改善本文档。我期待着您的参与。



声明

本编程规范文档以“如是”提供，无论明示或暗示都不包含任何形式保证，但并不限制适用于特殊目的的默

认担保。

当您编写 --代码时，敬请参考或使用本文档。但是，我们希望您能通过

(./0/ 告知我们您正在使用本文档，或给出任何改进建议。

目录

1 概览.................................................................................................................................................1

11原则和主旨1

3变量的声明和初始化3

5函数的声明和调用5

6代码语句 6

7枚举6

8大括号 1

1注释1

11代码块

3 .NET 编码规范...............................................................................................................................20

21类库开发设计规范

2文件和结构

28类 2

21命名空间23

211错误和异常23

21资源清理26

1

1 概览

本文档为一站式示例代码库项目组所使用的 以及 编码规范 。该规范源自于产品开发过程中的经

验，并在不断完善。如果您发现一些最佳实践或者话题并没有涵盖在本文档中，请联系我们一站式示例

代码库项目组 ，以不断充实完善本文档。

任何指导准则都可能会众口难调。本规范的目的在于帮助社区开发者提高开发效率，减少代码中可能出

 正确性 – 示例代码必须正确展示出其欲告知使用者的重点。代码必须经过测试，且可以按照文档

描述进行编译和运行。

2 一致性 – 示例代码应该按照一致的编程风格和设计来保证代码易读。 同样的，不同代码示例之间

也应当保持一致的风格和设计，使使用者能够很轻松的结合使用它们。一致性将我们一站式示例

代码库优良的品质形象传递给使用者，展示出我们对于细节的追求。

4 流行性 – 代码示例应当展示现行的编程实践，例如使用 ;(，错误处理，防御式编程以及可

移植性。示例代码应当使用当前推荐的运行时库和 )< 函数，以及推荐的项目和生成设置。

=15$0)#+,(



3 可靠性 – 代码示例必须符合法律，隐私和政策标准和规范。不允许展示入侵性或低质的编程实践，

不允许永久改变机器状态。所有的安装和执行过程必须可以被撤销。

些指导准则并不一定处处适用，但是会在特定的场景下带来益处。为了清楚陈述规范和实践的意图，我

们会使用如下术语。

术语 意图 理由

一定请... 该规范或实践在任何情况下都应该遵守。如果您

认为您的应用是例外，则可能不适用。

该规范用于减少 9。

一定不要... 不允许应用该规范或实践。

您应该... 该规范和实践适用于大多数情况。 该规范用于统一编程风格，保

持一致和清晰的风格。

您不应该.. 不应该应用该规范或实践，除非有合理的理由。

您可以… 该标准和规范您可以按需应用。 该规范可用于编程风格，但不