本文档根据Google 开源项目风格指南撰写,并非重复此文档,仅整理关键点作为cheat sheet之用。
1.头文件
1.1. Self-contained 头文件
头文件应该能够自给自足(self-contained,也就是可以作为第一个头文件被引入),以.h
结尾。至于用来插入文本的文件,说到底它们并不是头文件,所以应以.inc
结尾。不允许分离出-inl.h
头文件的做法.
1.2. #define 保护
所有头文件都应该使用 #define 防止头文件被多重包含, 命名格式当是: <PROJECT>_<PATH>_<FILE>_H_
1.3. 前置声明
尽可能地避免使用前置声明[类、函数和模板的纯粹声明,没伴随着其定义]。使用#include
包含需要的头文件即可。
1.4. 内联函数
只有当函数只有 10 行甚至更少时才将其定义为内联函数
知识共享许可协议 本作品采用知识共享署名 4.0 国际许可协议进行许可。
网友评论