Clean C++:包含模式

物理设计:包含模式

一般地,#include用于包含头文件。本文讲述了几类包含模式,包括降低冲突概率的方案,权衡绝对模式与相对模式的利弊,最大的代码可移植性的方法。

降低冲突概率

单文件模式(反模式)

在大型的C/C++项目,-I选项可能包含多个搜索路径。如果#include仅仅包含单一的文件名,则可能存在冲突的概率。例如,其他子模块也存在一个mutex.h的头文件,而且其搜索优先级相对当前目录高,则必然出现冲突。

#include "mutex.h"

为了降低冲突概率,一般在文件名的前缀追加名字空间。例如,

#include "cub_mutex.h"

绝对模式(推荐)

推荐使用#include "project/module/sub_module/file_name.h的全路径模式,保证其全局唯一性。另外,该模式可以简化和统一配置管理工作,只需将该项目的顶级目录添加至-I选项即可。

#include "cub/concurrent/mutex.h"

事实上,#include使用的都是相对模式,绝对模式相对于-I选项的搜索路径集合。此处,绝对模式指的是始于项目的根目录,不包含相对路径.或者..的包含风格。

相对模式(反模式)

使用相对模式,使得#include的包含风格缺乏统一性,而且使得人难以理解。移动目录时,重构相应的#include语句相对更容易出错。

#include "./mutex.h"
#include "../fs/uri.h"

最大化移植性

分隔符

包含头文件时,路径分隔符一律使用Unix风格,拒绝使用Windows风格;即采用/分割路径,而不是使用\。使用Unix风格的分隔符,程序具有最大的可移植性,而采用Windows风格的\,只能在Windows生态的编译器上编译代码。

Windows风格(反模式)
#include "cut\core\synchronized_object.h"
Unix风格(推荐)
#include "cut/core/synchronized_object.h"

大小写

Windows生态中的编译器往往对大小写不敏感,而Unix生态中的编译器则对大小写是敏感的,这是两个生态不同的价值观导致的分歧。为了最大化可移植性,#include的路径名和文件名一律大小写。

驼峰风格(反模式)
// 路径名、文件名使用大写
#include "CUT/Core/SynchronizedObject.h"
#include "CUT/YAMLParser/Syntax.h"
一律小写(推荐)
// 路径名、文件名使用小写
#include "cut/core/synchronized_object.h"
#include "cut/yaml_parser/syntax.h"

但是,文件中的驼峰风格与之小写风格的文件名存在两种不同的命名风格。幸运的是,主流IDE重命名文件名或类名时,两者能够保持一致。

约定优于配置

统一风格,可以使代码更加优美和对称。项目中坚持使用绝对模式的单一风格,可以极大地降低编译器的配置管理工作,使得团队成员更容易达成一致的默契,也利于团队和团队之间保持一致价值观。相反地,每个开发者,或每个团队都存在各自的个性和风格,对整个公司或产品是极为不利的。

<> 与 ""

社区对于两种风格,争论从未停止,存在两种风格。

  • 一律使用<>
  • 标准库使用<>,其他使用""

前者优势在于统一,程序员不用动脑;后者在于显式的区分,而且社区接受程度高。两者各有优缺点,最关键的是选择一种风格,并一如既往的坚持最初的决定。

后缀名

理论上,#include可以包含任何的文本文件、头文件使用h, hpp, hxx等后缀,实现文件使用cc, cpp, cxx等后缀名。一致的后缀名,可以极大地降低编译器的配置管理工作。要么h, cc, 要么h, cpp;不可h, hpp; cpp, cc混合搭配。

如果自定义的头文件没有后缀名,这是愚蠢的做法。该风格被标准库保留,自定义的头文件将极大概率与现有或未来的标准库存在冲突,而且会违背社区的主流的习惯和约定。例如,著名的Eigen库就是一种典型的反模式,我手中的所有IDE或编辑器(下图是vi编辑器),其代码着色功能全部失效,给代码的阅读和维护造成了很大的障碍。

为了能够在Eclipse CDT中恢复这些没有后缀头文件的代码着色功能,Eigen在官方文档中给出了一套配置方法。可以想象,违背“约定由于配置”的原则,不仅给客户带来麻烦,也给自己带来了不必要的负担。

反模式: Eigen库的头文件
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,425评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,058评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,186评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,848评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,249评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,554评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,830评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,536评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,239评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,505评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,004评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,346评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,999评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,060评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,821评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,574评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,480评论 2 267

推荐阅读更多精彩内容

  • 官网 中文版本 好的网站 Content-type: text/htmlBASH Section: User ...
    不排版阅读 4,310评论 0 5
  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,034评论 1 32
  • 来自陈浩的一片老文,但绝对营养。 示例工程:3 个头文件*.h,和 8 个 C 文件*.c。 初 编译过程,源文件...
    周筱鲁阅读 4,604评论 0 17
  • WinRAR - 最新版本的更新 版本 5.50 1. WinRAR 和命令行 RAR 默认使用 RAR ...
    王舒璇阅读 2,281评论 0 2
  • 一、Python简介和环境搭建以及pip的安装 4课时实验课主要内容 【Python简介】: Python 是一个...
    _小老虎_阅读 5,618评论 0 10