前言
文章内容由林锐编写的《高质量C/C++编程指南》结合自身在学习中遇到的困难整理出来的常见问题。希望帮助大家,快速了解一些编程规范。
一、文件结构
每个C/C++程序通常分为两个文件。一个文件用于保存程序的声明(declaration),称为头文件。另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。
C/C++程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀,C++程序的定义文件通常以“.cpp”为后缀。
1.1头文件的结构
为了防止头文件被重复引用,应当在头文件的第一行添加#pragmaonce,也可以用ifdef/define/endif结构产生预处理块。
用#includefilename.h格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。
用#include“filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。
头文件中只存放"声明",而不存放"定义"。
不提倡使用全局变量,尽量不要在头文件中出现像enternintvalue这类声明。
1.2定义文件的结构
定义文件由两部分内容:
1.对头文件的引用。
2.程序的实现体(包括数据和代码)。
1.3头文件的作用
(1)通过头文件来调用库功能。在很多场合,源代码不便(或不准)向用户公布,只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能,而不必关心接口怎么实现的。编译器会从库中提取相应的代码。
(2)头文件能加强类型安全检查。如果某个接口被实现或被使用时,其方式与头文件中的声明不一致,编译器就会指出错误,这一简单的规则能大大减轻程序员调试、改错的负担。
二、程序的版式
版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。
2.1空行
空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。
在每个类声明之后、每个函数定义结束之后都要加空行。
在一个函数体内,逻辑上密切相关的语句之间不加空行,其他地方应加空行分隔。
2.2代码行
一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样代码容易阅读,并且方便于写注释。
if、for、while、do等语句独占一行,执行语句不得紧随其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
尽可能在定义变量的同时初始化该变量。以防止忘记初始化,引用了未被初始化的变量,可能会导致程序错误。
2.3注释
注释通常用于:
(1)函数借口的说明;
(2)重要代码行或段落提示。
注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。注释的花样要少。
边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可以放在下方。
当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。
三、命名规则
标识符应当直观且可以拼读,可望文知意,不必进行“解码”。标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。
程序中不要出现仅靠大小写来区分的相似的标识符。例如:
变量的名字应当使用“名词”或者“形容词+名词”。例如:
全局函数的名字应当使用“动词”或者“动词+名词”(动宾组合)。类的成员函数应当只使用“动词”,被省略的名词就是对象本身。例如:
用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如:
类名和函数名用大写字母开头的单词组合而成。例如:
变量和参数用小写字母开头的单词组合而成。
例如:
intdrawMode;
floatminValue;
常量全用大写字母,用下划线分隔单词。
constintMAX=;
constintMAX_LENGTH=;
静态变量加前缀s_(表示static)。
staticints_initValue;//静态变量
全局变量加前缀g_(global)。
intg_howManyPeople;//全局变量
intg_howMuchMoney;//全局变量
类的数据成员函数加前缀m_(表示member,也可以加前缀_或后缀_),这样可以避免数据成员与成员函数的参数同名。