C/C++/C# 编码规范
1 概述
本规范的目的在于帮助开发者提高开发效率,减少代码中可能出现的 ,并增强代码的可维护性。
万事开头难,采纳一个不熟悉的规范可能在初期会有一些棘手和困扰,但是这些不适应很快便会消失,
它所带来的好处和优势很快便会显现,特别是在当您接手他人代码时。
.1 原则和主旨
高质量的代码示例往往具有如下特质
易懂–代码示例必须易读且简单明确。它们必须能展示出重点所在。示例代码的相关部分应当易
于重用。示例代码不可包含多余代码。它们必须带有相应文档说明。
正确性–示例代码必须正确展示出其欲告知使用者的重点。代码必须经过测试,且可以按照文档
描述进行编译和运行。
一致性–示例代码应该按照一致的编程风格和设计来保证代码易读。同样的,不同代码示例之间
也应当保持一致的风格和设计,使使用者能够很轻松的结合使用它们。
流行性–代码示例应当展示现行的编程实践,例如使用,错误处理,防御式编程以及可
移植性。
可靠性–代码示例必须符合法律,隐私和政策标准和规范。不允许展示入侵性或低质的编程实践,
不允许永久改变机器状态。所有的安装和执行过程必须可以被撤销。
安全性示例代码应该展示如何使用安全的编程实践:例如最低权限原则,使用运行时库函数的
安全版本,以及 ! 推荐的项目设置。
合理使用编程实践,设计和语言特性决定了示例代码是否可以很好满足上述特性。本编程规范致力于帮
助您创建代码示例以使使用者能够作为最佳实践来效仿和学习。