发布时间 : 2024/6/5 2:05:52 星期三 文章2010 - C++编码规范更新完毕开始阅读

方便程序的测试、维护、升级等工作，同时，也用以培养学生书写规范代码的习惯。

2 一般性原则

为了书写出清晰而易维护的代码，以下的一般性原则可以在所有的情况下应用到:

?

重用性。软件工程师的一个目标就是通过重复使用代码来避免编写新的代码。因为重新使用已有的代码可以降低成本、增加代码的可靠性并提高它们的一致性。 ?

可维护性。一段风格良好的代码肯定具有很好的可读性。如果代码的维护者不明白你所书写的代码的含义，那么代码的维护就会成为一件十分困难而耗时的工作，所以在你编写代码的时候，一定要时刻的考虑到你所书写的代码别人是不是能够真正理解。

? 模块化，封装和信息隐藏。如果一个模块的代码过长或者过于复杂，一定要考虑你的模块是不是需要重新组织一下，或者将一个模块分解成多个模块。

? 不要对使用你代码的用户抱有太多的幻想。要让代码保护自己不被错误使用。

? 书写注释。注释可以帮助别人更好的理解你的代码，尽管这一条经常被软件开发人员忽视，但是对于代码的作者，使用者或者维护人员来说，代码注释在提高代码的可读性和可维护性方面是十分必要的。

? 保持代码风格的一致性，无论是在文件级别，模块级别，还是工程级别，请保持代码风格的一致性。

? 变量、函数、类和名字空间的命名要使用有意义的英文单词，且命名不要过长，简明易懂为佳，尽量不要使用缩写，更不要使用汉语拼音。

3 文件结构 3.1 一般性问题

?

文件名使用字母、数字、下划线(不推荐)的组合来命名，但命名要有意义。 ? ?

所有的目录名，文件名一律用小写字母书写。 一个文件中只能定义或者实现一个类，唯一的例外是小型的帮助类或私有的内部类可以和它的主类定义在同一个文件中。 ?

文件中不允许包含废弃不用的源代码。

3.2 头文件

?

为了防止头文件被重复引用，应当用#ifndef/#define/#endif结构产生预处理块。

? 用#include 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。

? 用#include \格式来引用非标准库的头文件（编译器将从当前目录开始搜索，若没有找到则从标准库目录搜索）。

? 一般情况下，将构造函数和析构函数声明在类的开头位置。

? 将从父类继承的函数放在不同的位置，并添加注释说明这些成员函数是从哪个类继承而来的

? ?

声明写在头文件中，定义写在源文件中。 避免使用全局变量，尽量不要在头文件中出现象extern int value 这类声明。

? 尽量用类中公共的静态成员函数取代全局函数。