c/c++编码规范(1)--头文件

标签：

最近工作稍微轻松一点，就再学习了一下编码规范。遂记些笔记，以便查阅。

这次学习的是Google 开源项目风格指南中文版，地址是：http://zh-google-styleguide.readthedocs.org/en/latest/google-cpp-styleguide/，英文版的地址是：http://google.github.io/styleguide/cppguide.html。

本文的目的是方便快速查阅，所以我只简单的记录该怎么做，而没有写为什么要这样做。想要看详细分析，可查阅原版资料。本文只是摘要了一些会在最近工作中需要用到的条目，并未完整的提取原版中内容。

1. 头文件

1.1. self-contained头文件

 头文件本身依赖的其它头文件，需要全部包含。

1.2. #define保护

#ifndef FOO_BAR_BAZ_H_
#define FOO_BAR_BAZ_H_
…
#endif // FOO_BAR_BAZ_H_

a. 为了保证唯一性，#define的格式是 工程名+源代码树的全路经。

b. #endif后面要加注释

1.3. 内联函数

10行以内的简单代码才使用内联函数。不要内部有函数调用，不要有switch。

1.4. 函数参数顺序

输入参数在前，输出参数在后。有输入输出两用参数时，可不严格遵循此规则。

1.5. #include的路径及顺序

a. 为避免隐藏依赖，头文件包含的顺序是：

 　  相关头文件(本文件对应的头文件)，

　　C库，

　　C++库，

　　其它库，

　　项目内.h

b. 包含头文件时，使用源码的目录树结构，避免使用  .  和  .. 。

如 #include “base/logging.h”

c. 条件编译的头文件，可以放在其它头文件之后

c/c++编码规范(1)--头文件

标签：

原文地址：http://www.cnblogs.com/gaoshenghg/p/4744412.html