编码规范

编码规范补充

1. 头文件

1.1. include guard

所有头文件都应该使用#define 防止头文件被多重包含。

为保证唯一性,头文件的命名应基于其所在项目源代码树的全路径。例如,项目foo 中的头文件foo/src/bar/baz.h 按如下方式保护:

#ifndef FOO_BAR_BAZ_H_

#define FOO_BAR_BAZ_H_

...

#endif // FOO_BAR_BAZ_H_

1.2. 尽量使用 forward declaration

使用前向声明(forward declarations),尽量减少.h 文件中#include 的数量。

当一个头文件被包含的同时也引入了一项新的依赖,只要该头文件被修改,代码就要重新编译。使用前置声明可以显著减少需要包含的头文件数量。

举例说明:头文件中用到类File,但不需要访问File 的声明,则头文件中只需前置声明class File;无需

#include"file/base/file.h"

namespace 中的 class 都可以前向声明,模板也可以前向声明,例如 class Foo; typedef std::shared_ptr<Foo> FooPtr。但是 nested class 无法前向声明。

1.3. 头文件包含顺序

  • 保证每个构成interface的头文件都独立可用,xxx.cpp 文件第一个包含的头文件应该是 xxx.h。

  • cpp 文件和头文件中写 include 时按一定的原则分组(例如本项目、本公司、第三方C++库、C++标准库、第三方C库),每组以内按字母顺序排列头文件。

  • cpp 文件中的头文件有以下两种常用包含顺序:

  • 《Google C++ Style Guide》推荐顺序:(对xxx.cpp)

    • xxx.h
    • C 系统文件
    • C++ 系统文件
    • 其他库的 .h 文件
    • 本项目内 .h 文件
  • 《C++编程思想》推荐顺序:(对xxx.cpp)

    • xxx.h
    • 本项目内 .h 文件
    • 其他库的 .h 文件
    • C++ 系统文件
    • C 系统文件
  • 两者相同的地方是将xxx.h 放在开始,避免隐藏依赖

  • 第一种的优点:符合从一般到特殊的顺序,比较容易理解。
    第二种的优点:符合从特殊到一般的顺序,能够暴露出自己的头文件是不是包含了所有必需的系统文件。如果某个自己的头文件没有包含必需的系统文件的话,会导致编译错误。

  • 建议使用第二种包含顺序。

2.变量命名

1. 匈牙利命名法的缺点

(1)一些版本的匈牙利约定事实上忽视了用抽象数据类型作为基本类型。它们以程序语言中整型、长整型、浮点数和字符串为基础来建立基本类型。

(2)匈牙利约定基本类型事实上是没有什么价值的,因为它使得程序员陷入对类型进行人工检查的困扰之中,而不是让编译程序对类型进行更加快速而又准确的检查。这种形式匈牙利约定的另一个问题是它把数据的意义与其表现联系在一起。比如,说明某一变量是整型的,把它改为长整型的时,不得不改动这一变量的名称。

(3)匈牙利约定的最后一个问题是它鼓励了懒惰、不含什么信息的变量名的出现。当程序员用hwnd 来命名对窗口的操作时,往往忽视了他所指的到底是哪种窗口、对话框、菜单还是帮助区的屏幕?显然用 hwndmenu 要比 hwnd 清楚得多。以变量的意义为代价来获得对其类型的精确描述显然是愚蠢的。不过好在可以用加限定词的办法来同时获得完整的意义和精确的类型。

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

推荐阅读更多精彩内容