谷歌大牛的 C 语言编程建议和技巧

【伯乐在线导读】:本文作者 Rob Pike 是谷歌公司最著名的软件工程师之一,曾是贝尔实验室 Unix 开发团队成员,Plan 9 操作系统开发的主要领导人,Inferno 操作系统开发的主要领导人。他是缔造 Go 语言和 Limbo 语言的核心人物。和 Brian Kernighan 合著过两本书:《The Unix Programming Environment》 和 《程序设计实践(The Practice of Programming)》。

本文介绍的建议和技巧,是 Rob Pike 写于 1989 年 2 月,伯乐在线编译如下。

介绍

Kernighan 和 Plauger 编写的《The Elements of Programming Style》,是一本很重要而且公认有很大影响力的书。但有时候我觉得对于书中的简洁规则,可以看做是一种好的烹饪方法,而不是想简洁的表达一种哲学思维。倘若这本书声称应该有意义地选择变量名称,那么难道他们文章中对变量的命名更好?难道 MaximumValueUntilOverflow 比 maxval 更好吗? 我不这么认为。

下面是一篇简短的文章,总体上鼓励在编程时应有清晰的哲学思维,而不是给予硬性规则。我并不希望你们能认可所有的东西,因为它们只是观点,观点会随着时间的变化而变化。可是,如果不是直到现在把它们写在纸上,长久以来这些基于许多经验的观点一直积累在我的头脑中。因此希望这些观点能帮助你们,了解如何规划一个程序的细节。(我还没有看到过一篇讲关于如何规划整个事情的好文章,不过这部分可以是课程的一部分)要是能发现它们的特质,那很好;要是不认同的话,那也很好。但如果能启发你们思考为什么不认同,那样就更好了。在任何情况下,都不应该照搬我所说的方式进行编程;要用你认为最好的编程方式来尝试完成程序。请一以贯之而且毫不留情的这么做。

欢迎您的评论。

排版问题

程序是一种出版物。意味着程序员们会先阅读(也许是几天、几周或几年后的你自己阅读),最后才轮到机器。机器的快乐就是程序能编译,机器才不在乎程序写的有多么漂亮,可是人们应该保持程序的美观。有时人们会过度关心:用漂亮的打印机呆板地打印出漂亮的输出,而这些输出只是将所有介词用英文文本以粗体字体凸显出来,都是些与程序无关的细节。虽然有很多人认为程序就应该像 Algol­68 所描述的一样(有些系统甚至要求照搬该风格编写程序),可清晰的程序不会因为这样的呈现而变得更清晰,只会使糟糕的程序变得更可笑。

对于清晰的程序来说,排版规范一向都是至关重要的。当然,众所周知最有用的是缩进,但是当墨水遮盖了意图时,就会控制住排版。因此即便坚持使用简单的旧打字机输出,也该意识到愚蠢的排版。避免过度修饰,比如保持注释的简洁和灵活。通过程序整齐一致地说出想表达的。接着往下看。

变量命名

对于变量名称,长度并不是名称的价值所在,清晰的表达才是。不常用的全局变量可能会有一个很长的名称,像 maxphysaddr。在循环中每一行所使用的数组索引,并不需要取一个比 i 更详尽的名字。取 index 或者 elementnumber 会输入更多的字母(或调用文本编辑器),并且会遮盖住计算的细节。当变量名称很长时,很难明白发生了什么。在一定程度上,这是排版问题,看看下面

vs.

现实例子中的问题会变得更糟。所以仅需把索引当成符号来对待。

指针也需要合理的符号。np 仅仅只是作为指针 nodepointer 的助记符。如果一贯都遵从命名规范,那么很容易就能推断出 np 表示“节点指针”。在下一篇文章中会提到更多。

同时在编程可读性的其它方面,一致性也是极其重要的。假使变量名为 maxphysaddr,则不要给同级关系的变量取名 lowestaddress。

最后,我倾向于「最小长度」但「最大信息量」的命名,并让上下文补齐其余部分。例如:全局变量在使用时很少有上下文帮助理解,那么它们的命名相对而言更需要令人易懂。因此我称 maxphyaddr (不是 MaximumPhysicalAddress)作为一个全局变量名,对于在本地定义和使用的指针来说 np 并不一定是 NodePoint。这是品味的问题,但品味又与清晰度相关。

我避免在命名时嵌入大写字母;在我经验丰富的双眼中,它们的阅读舒适性太别扭了,像糟糕的排版一样令人心烦。

指针的使用

C 语言不同寻常,因为它允许指针指向任何事物。指针是锋利的工具,像任何这样的工具一样,使用得当可以产生令人愉悦的生产力,但使用不当也可以造成极大的破坏(在写这篇文章的前几天,我把木工凿插到拇指里了)。指针在学术界的名声不太好,因为它太危险了,莫名其妙地就变得糟糕的不行。但我认为它是强大的符号,它可以帮助我们清楚地自我表达。

思考:当有指针指向对象时,对于那个对象,确切地说它只是名称,其它什么也不是。听起来很琐碎,但看看下面的两个表达式:

第一个指向一个 node(节点),第二个计算为(可以说)同一个 node。但第二种形式是不太容易理解的表达式。这里解释一下,因为我们必须要知道 node 是什么,i 是什么,还要知道 i 和 node 与周围程序之间相关(可能不是很详细)的规则是什么。孤立的表达式并不能说明 i 是 node 的有效索引,更不用提是我们想要元素的索引。如果 ijk 都是 node 数组中的索引将很容易出差错,而且连编译器都不能帮助找出错误。当给子程序传参数时,尤其容易出错:指针只是一个单独的参数;但在接收的子程序中必须认为数组和索引是一体的。

计算为对象表达式本身,比该对象的地址更不易察觉,而且容易出错。正确使用指针可以简化代码:

vs.

如果想取下一个元素的 type 可以是

i 前移,但其余的表达式必须保持不变;用指针的话,只需要做一件事,就是指针前移。

把排版因素也考虑进来。对于处理连续的结构体来说,使用指针比用表达式可读性更好:只需要较少的笔墨,而且编译器和计算机的性能消耗也很小。与此相关的问题是,指针类型会影响指针正确使用,这也就允许在编译阶段使用一些有用的错误检测,来检查数组序列不能分开。而且如果是结构体,那么它们的标签字段就是其类型的提示。因此

是足以让人明白的。如果是索引数组,数组将取一些精心挑选的名字,而且表达式也会变得更长:

此外,由于例子变得越来越大,额外的字符更加让人恼火。

一般来说,如果发现代码中包含许多相似并复杂的表达式,而且表达式计算为数据结构中的元素,那么明智地使用指针可以消除这些问题。考虑一下

看起来像利用复合表达式表示 p。有时这值得用一个临时变量(这里的 p)或者把运算提取成一个宏。

过程名称

过程名称应该表明它们是做什么的,函数名称应该表明它们返回什么。函数通常在像 if 这样的表达式使用,因此可读性要好。

是没有太大帮助的,因为不能推断出 checksize 错误时返回 true,还是非错误时返回。相反

使这点能清晰表达,并且在常规使用中将来也不大可能出错。

注释

这一个微妙的问题,需要自己体会和判断。由于一些原因,我倾向于宁可清除注释。第一,假如代码清晰,并且使用了规范的类型名称和变量名称,应该从代码本身就可以理解。第二,编译器不能检查注释,因此不能保证准确,特别是代码修改过以后。误导性的注释会非常令人困惑。第三,排版问题:注释会使代码变得杂乱。

但有时我会写注释,像下文一样仅仅只是把它们用于介绍。例如:解释全局变量的使用和类型(我总是在庞大的程序中写注释);作为一个不寻常或者关键过程的介绍;或标记出大规模计算的一节。

有一个糟糕注释风格的例子:

还有更糟糕的做法:

先不要嘲笑,等到在现实中看到再去吧。

或许除了诸如重要数据结构的声明(对数据的注释通常比对算法的更有帮助),这样至关重要部分之外,需要避免对注释的“可爱”排版和大段的注释;基本上最好就不要写注释。如果代码需要靠注释来说明,那最好的方法是重写代码,以便能更容易地理解。这就把我们带到了复杂度。

复杂度

许多程序过于复杂,比需要有效解决的问题更加复杂。这是为什么呢?大部分是由于设计不好,但我会跳过这个问题,因为这个问题太大了。然而程序往往在微观层面就很复杂,有关这些可以在这里解决。

规则 1:不要断定程序会在什么地方耗费运行时间。

瓶颈总是出现在令人意想不到的地方,直到证实瓶颈在哪,不要试图再次猜测并加快运行速度。

规则 2:估量(measure)

在没有对代码做出估量之前不要优化速度,除非发现最耗时的那部分代码,要不也不要去做。

规则 3:当 n 很小时(通常也很小),花哨的算法运行很慢。

花哨算法有很大的常数级别复杂度。在你确定 n 总是很大之前, 不要使用花哨算法。(即使假如 n 变大,也优先使用规则 2).例如,对于常见问题,二叉树总比伸展树高效。

规则 4:花哨的算法比简单的算法更容易有 bug,而且实现起来也更困难

尽量使用简单的算法与简单的数据结构。

以下几乎是所有实际程序中用到的数据结构:

数组
链表
哈希表
二叉树

当然也必须要有把这些数据结构灵活结合的准备,比如用哈希表实现的符号表,其中哈希表是由字符型数组组成的链表。

规则 5:以数据为核心

如果选择了适当的数据结构并把一切都组织得很有条理性,算法总是不言而喻的。编程的核心是数据结构,而不是算法。(参考 Brooks p. 102)

规则 6:就是没有规则 6。

数据编程

不像许多 if 语句,算法或算法的细节通常以紧凑、高效和明确的数据进行编码。眼前的工作可以编码,归根到底是由于其复杂性都是由不相干的细节组合而成。分析表是典型例子,它通过一种解析固定、简单代码段的形式,对编程语言的语法进行编码。有限状态机特别适合这种处理形式,但是几乎任何涉及到对构建数据驱动算法有益的程序,都是将某些抽象数据类型的输入“解析”成序列,序列会由一些独立“动作”构成。

也许这种设计最有趣的地方是表结构有时可以由另一个程序生成(经典案例是解析生成器)。有个更接地气的例子,假如操作系统是由一组表驱动,这组表包含连接 I/O 请求到相应设备驱动的操作,那么可以通过程序“配置“系统,该程序可以读取到某些特殊设备与可疑机器连接的描述,并打印相应的表。

数据驱动程序在初学者中不常见的原因之一是由于 Pascal 的专制。 Pascal 像它的创始人一样,坚信代码要和数据分开。因而(至少在原始形式上)无法创建初始化的数据。与图灵和冯诺依曼的理论背道而驰,这些理论可都是定义存储计算机的基本原理。代码和数据是一样的,或至少可以算是。还能怎样解释编译器的工作原理呢?(函数式语言对 I/O 也有类似的问题)

函数指针

Pascal 专制的另一个结果是初学者不使用函数指针。(在 Pascal 中没有把函数作为变量) 用函数指针来处理编码复杂度会有一些令人感兴趣的地方。

指针指向的程序有一定的复杂度。这些程序必须遵守一些标准协议,像要求一组都是相同调用的程序就是其中之一。除此之外,所要实现的只是完成业务,复杂度是分散的。

有个协议的主张是既然所有使用的功能相似,那么它们的行为也必须相似。这对简单的文档、测试、程序扩展和甚至使程序通过网络分布都有帮助——远程过程调用可以通过该协议进行编码。

我认为面相对象编程的核心是清晰使用函数指针。规定好要对数据执行的一系列操作,以及对这些操作响应的整套数据类型。将程序合拢到一起最简单的方法是为每种类型使用一组函数指针。简而言之,就是定义类和方法。当然,面向对象语言提供了更多更漂亮的语法、派生类型等等,但在概念上几乎没有提出额外的东西。

数据驱动程序与函数指针的结合,变成了一种表现令人惊讶的工作方法。根据我的经验,这种方法经常会产生惊喜的结果。即使没有面向对象语言,无需额外的工作也可以获得 90% 的好处,并且能更好地管理结果。我无法再推荐出更高标准的实现方式。我所有的程序都是由这种方式组织管理,而且经过多次开发后都相安无事——远远优于缺少约束的方法。也许正如所说:从长远来看,约束会带来丰厚的回报。

包含文件

简单规则:包含(include)文件时应该永远不要嵌套包含。

如果声明(在注释或隐式声明里)需要的文件没有优先包含进来,那么使用者(程序员)要决定包含哪些文件,但要以简单的方式处理,并采用避免多重包含的结构。多重包含是系统编程的祸根。将文件包含五次或更多次来编译一个单独的 C 源文件的事情屡见不鲜。Unix 系统中 /usr/include/sys 就用了这么可怕的方式。

说到 #ifdef,有一个小插曲,虽然它能防止读取两次文件,但实际上经常用错。#ifdef 是定义在文件本身中,而不是文件包含它。结果是常常导致让成千上万不必要的代码通过词汇分析器,这是(优秀编译器中)耗费最大的阶段。

只需遵从以上简单规则。

2 9 收藏 3 评论

关于作者:PJing

简介真还没来得及写 :) : ( 个人主页 · 我的文章 · 13

相关文章

可能感兴趣的话题



直接登录
最新评论
  • 王念一 初三学生 04/23

    然而『if(validsize(x))』这句的命名风格就不规范,应该用动词形式 validate 而非形容词 valid。

    • wx_QO8SD8LO   04/25

      如果将if(validsize(x))直接翻译是 如果x是合法的大小

      像你说的validate,直接翻译是 如果使x合法化

      你说哪个更对?

      • 王念一 初三学生 04/28

        谁告诉你这个 validate 是【使……合法化】了?

        validate 在此处意思是【验证】。

        名词性词组做方法名不合日耳曼语系使用者的习惯。

跳到底部
返回顶部