All-In-One Code Framework Coding Standards 微软一站式编码.docx

鸣谢本文档的每一章节都应该感谢Dan Ruder - 微软Principal Escalation Engineer 。 Dan 对本文档进行了斟字酌句的查阅，并根据其20余年的编程经验提供了大量的珍贵评论 。我很荣幸能与他共事。 我同样感谢微软的四位经理，感谢他们对该项目的一贯支持。他们是Vivian Luo，Allen Ding，Felix Wu 和 Mei Liang。 同时，如果没有如下一站式代码示例库项目的关键成员的辛勤付出，本文档必定不会具有现在的技术深度以及完整度，我在这里要感谢他们：Hongye SunJie WangJi ZhouMichael SunKira QianLinda LiuAllen Chen Yi-Lun LuoSteven ChengWen-Jun Zhang本文档部分章节参考自一些微软产品组的编程规范。感谢他们的慷慨共享。本编程规范在不断改善。如果您发现某些最佳实践或者话题并没有涵盖在本文档中，请告知我们mailto:onecode@一站式示例代码库项目组 ，以不断充实改善本文档。我期待着您的参与。声明本编程规范文档以“如是”提供，无论明示或暗示都不包含任何形式保证，但并不限制适用于特殊目的的默认担保。 当您编写VC++/VC#/VB.NET 代码时，敬请参考或使用本文档。但是，我们希望您能通过mailto:onecode@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代码块263C++ 编程规范273.1编译器选项273.2文件和结构293.3命名规范303.4指针343.5常量343.6类型转换353.7Sizeof363.8字符串373.9数组383.10宏393.11函数403.12结构体433.13类443.14COM503.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概览 本文档为http://1一站式示例代码库项目组所使用的C++ 以及 .NET 编码规范 。该规范源自于产品开发过程中的经验，并在不断完善。如果您发现一些最佳实践或者话题并没有涵盖在本文档中，请联系我们mailto:onecode@一站式示例代码库项目组 ，以不断充实完善本文档。任何指导准则都可能会众口难调。本规范的目的在于帮助社区开发者提高开发效率，减少代码中可能出现的bug，并增强代码的可维护性。万事开头难，采纳一个不熟悉的规范可能在初期会有一些棘手和困扰，但是这些不适应很快便会消失，它所带来的好处和优势很快便会显现，特别是在当您接手他人代码时。原则和主旨高质量的代码示例往往具有如下特质:易懂 – 代码示例必须易读且简单明确。它们必须能展示出重点所在。示例代码的相关部分应当易于重用。示例代码不可包含多余代码。它们必须带有相应文档说明。正确性 – 示例代码必须正确展示出其欲告知使用者的重点。代码必须经过测试，且可以按照文档描述进行编译和运行。一致性 – 示例代码应该按照一致的编程风格和设计来保证代码易读。 同样的，不同代码示例之间也应当保持一致的风格和设计，使使用者能够很轻松的结合使用它们。一致性将我们一站式示例代码库优良的品质形象传递给使用者，展示出我们对于细节的追求。流行性 – 代码示例应当展示现行的编程实践，例如使用 Unicode，错误处理，防御式编程以及可移植性。示例代码应当使用当前推荐的运行时库和API函数，以及推荐的项目和生成设置。可靠性 – 代码示例必须符合法律，隐私和政策标准和规范。不允许展示入侵性或低质的编程实践，不允许永久改变机器状态。所有的安装和执行过程必须可以被撤销。安全性 - 示例代码应该展示如何使用安全的编程实践 ：例如最低权限原则，使用运行时库函数的安全版本，以及SDL推荐的项目设置。 合理使用编程实践，设计和语言特性决定了示例代码是否可以很好满足上述特性。本编程规范致力于帮助您创建代码示例以使使用者能够作为最佳实践来效仿和学习。术语在整个文档中，会有一些对于标准和实践的推荐和建议。一些实践是非常重要的，必须严格执行，另一些指导准则并不一定处处适用，但是会在特定的场景下带来益处。为了清楚陈述规范和实践的意图，我们会