Microsoft C#编码规范.docVIP

MicrosoftC#编码规范本文档描述了微软一站式代码示例库项目组所采纳的关于本地C++和.NET（C#和VB.NET）代码的编程风格指导规范。鸣谢本文档的每一章节都应该感谢DanRuder-微软PrincipalEscalationEngineer。Dan对本文档进行了斟字酌句的查阅，并根据其20余年的编程经验提供了大量的珍贵评论。我很荣幸能与他共事。我同样感谢微软的四位经理，感谢他们对该项目的一贯支持。他们是VivianLuo，AllenDing，FelixWu和MeiLiang。同时，如果没有如下一站式代码示例库项目的关键成员的辛勤付出，本文档必定不会具有现在的技术深度以及完整度，我在这里要感谢他们：HongyeSun JieWang JiZhou MichaelSun KiraQian LindaLiuAllenChen Yi-LunLuo StevenCheng Wen-JunZhang本文档部分章节参考自一些微软产品组的编程规范。感谢他们的慷慨共享。本编程规范在不断改善。如果您发现某些最佳实践或者话题并没有涵盖在本文档中，请告知我们一站式示例代码库项目组，以不断充实改善本文档。我期待着您的参与。声明本编程规范文档以“如是”提供，无论明示或暗示都不包含任何形式保证，但并不限制适用于特殊目的的默认担保。当您编写VC++/VC#/VB.NET代码时，敬请参考或使用本文档。但是，我们希望您能通过onecode@告知我们您正在使用本文档，或给出任何改进建议。目录1 概览 11.1 原则和主旨 11.2 术语 22 通用编程规范 32.1 明确和一致 32.2 格式和风格 32.3 库的使用 52.4 全局变量 52.5 变量的声明和初始化 62.6 函数的声明和调用 72.7 语句 82.8 枚举 92.9 空格 142.10 大括号 152.11 注释 172.12 代码块 263 C++编程规范 273.1 编译器选项 273.2 文件和结构 293.3 命名规范 303.4 指针 343.5 常量 343.6 类型转换 353.7 Sizeof 363.8 字符串 373.9 数组 383.10 宏 393.11 函数 403.12 结构体 433.13 类 443.14 COM 503.15 动态分配 513.16 错误和异常 523.17 资源清理 553.18 控制流 584 .NET编码规范 614.1 类库开发设计规范 614.2 文件和结构 614.3 程序集属性 614.4 命名规范 614.5 常量 654.6 字符串 654.7 数组和集合 674.8 结构体 694.9 类 704.10 命名空间 744.11 错误和异常 744.12 资源清理 774.13 交互操作 901 概览本文档为一站式示例代码库项目组所使用的C++以及.NET编码规范。该规范源自于产品开发过程中的经验，并在不断完善。如果您发现一些最佳实践或者话题并没有涵盖在本文档中，请联系我们一站式示例代码库项目组，以不断充实完善本文档。任何指导准则都可能会众口难调。本规范的目的在于帮助社区开发者提高开发效率，减少代码中可能出现的bug，并增强代码的可维护性。万事开头难，采纳一个不熟悉的规范可能在初期会有一些棘手和困扰，但是这些不适应很快便会消失，它所带来的好处和优势很快便会显现，特别是在当您接手他人代码时。1.1 原则和主旨高质量的代码示例往往具有如下特质:1. 易懂–代码示例必须易读且简单明确。它们必须能展示出重点所在。示例代码的相关部分应当易于重用。示例代码不可包含多余代码。它们必须带有相应文档说明。2. 正确性–示例代码必须正确展示出其欲告知使用者的重点。代码必须经过测试，且可以按照文档描述进行编译和运行。3. 一致性–示例代码应该按照一致的编程风格和设计来保证代码易读。同样的，不同代码示例之间也应当保持一致的风格和设计，使使用者能够很轻松的结合使用它们。一致性将我们一站式示例代码库优良的品质形象传递给使用者，展示出我们对于细节的追求。4. 流行性–代码示例应当展示现行的编程实践，例如使用Unicode，错误处理，防御式编程以及可移植性。示例代码应当使用当前推荐的运行时库和API函数，以及推荐的项目和生成设置。5. 可靠性–代码示例必须符合法律，隐私和政策标准和规范。不允许展示入侵性或低质的编程实践，不允许永久改变机器状态。所有的安装和执行过程必须可以被撤销。6. 安全性-示例代码应该展示如何使用安全的编程实践：例如最低权限原则，使用运行时库函数的安全版本，以及SDL推荐的项目设置。合理使用编程实践，设计和语言特性决定了示例代码是否可以很好满足上述特性。本编程规范致力于帮助您创建代码示例以使使用者能够作为最佳实践来效