微软一站式示例代码库中文版

本文档为一站式示例代码库项目组所使用的C++ 以及 .NET 编码规范 。该规范源自于产品开发过程中的经验，并在不断完善。如果您发现一些最佳实践或者话题并没有涵盖在本文档中，请联系我们一站式示例代码库项目组 ，以不断充实完善本文档。

任何指导准则都可能会众口难调。本规范的目的在于帮助社区开发者提高开发效率，减少代码中可能出现的bug，并增强代码的可维护性。万事开头难，采纳一个不熟悉的规范可能在初期会有一些棘手和困扰，但是这些不适应很快便会消失，它所带来的好处和优势很快便会显现，特别是在当您接手他人代码时。
1.1 原则和主旨
高质量的代码示例往往具有如下特质:

1. 易懂 – 代码示例必须易读且简单明确。它们必须能展示出重点所在。示例代码的相关部分应当易于重用。示例代码不可包含多余代码。它们必须带有相应文档说明。

2. 正确性 – 示例代码必须正确展示出其欲告知使用者的重点。代码必须经过测试，且可以按照文档描述进行编译和运行。

3. 一致性 – 示例代码应该按照一致的编程风格和设计来保证代码易读。 同样的，不同代码示例之间也应当保持一致的风格和设计，使使用者能够很轻松的结合使用它们。一致性将我们一站式示例代码库优良的品质形象传递给使用者，展示出我们对于细节的追求。

4. 流行性 – 代码示例应当展示现行的编程实践，例如使用 Unicode，错误处理，防御式编程以及可移植性。示例代码应当使用当前推荐的运行时库和API函数，以及推荐的项目和生成设置。
...

2.1 明确性和一致性
 一定请确保代码的明确性，易读性和透明性。编程规范致力于确保代码是易懂和易维护的。没有什么胜于清晰、简洁、自描述的代码。

 一定请确保 一旦应用了某编程规范，需在所有代码中应用，以保持一致性。
2.2 格式和风格
 一定不要使用制表符。不同的文字编辑器使用不同的空格来生成制表符 ，这就带来了格式混乱。所有代码都应该使用4个空格来表示缩进。

可以配置Visual Studio 文字编辑器，以空格代替制表符 。
 

...