论文部分内容阅读
我学过半年编程,唯一的收获是记住了一个名字叫谭浩强。2009年我看过一本小说,讲程序员的故事,从此了解了一个新物种——程序猿,还知道个东西叫“良好的代码风格”,这几个字可比谭浩强有意思多了。可以跨领域应用,比方说,用在写作上。
例如,变量的命名。像本文,如果叫《论良好的代码风格》,姿态就不佳,一个“论”字就让读者反胃了。如果叫《如何写出良好风格的代码》,太装了,好像自己是编程大师似的。换一种叫法,《扯扯良好代码风格的淡》,感觉就亲民多了。
不过,本文也没那么叫,因为作者不忍心欺负程序猿。程序猿是很实诚的物种,被题目忽悠进来,发现作者根本不懂编程,就会愤怒得跟猩猩似的。
閑话休提。说到变量命名,金庸就是个中高手。像四大恶人的外号:恶贯满盈,无恶不作,凶神恶煞,穷凶极恶——同类型变量中包含特定的元素,一看就记住了。再比方,穆念慈和包惜弱,这两人从未谋面,名字却是工稳的对仗,暗指二人是母女关系:穆念慈的“慈”,就是一个指针指向包惜弱,包惜弱的“弱”也是一个指针指向穆念慈。慈就是母,弱就是子嘛。
《侠客行》开头有个“卖饼老者”,卖饼老者有没有名字呢?有,叫吴道通。那金庸为什么不直接称呼他“吴道通”呢?答曰:占用内存。读者记太多名字会累的,哪怕名字都是丁不三、包不同这种,多了也记不住。一个无名小卒,戏份太少,特地安个名字不划算。名字相当于一个指针,读者看到名字,首先想到这个人的特征和身份,才明确这个人。对于戏份太少的角色来讲,变量不存在多次赋值的问题,安排指针是大大的浪费。
但金庸还是说出了他的名字,不过金庸并不是直接以叙述的方式告诉读者他叫吴道通,而是通过他的对手骂他:“姓吴的,你想怎样……吴道通,你到底要怎样……”接下来,就自然替换成吴道通了。为什么又要替换呢?因为紧接着出现了第二个“老者”,若不替换,这老者和那老者就犯了重名的问题。可见,“老者”其实相当于一个局部变量。同样,“胖子”“店小二”也是。
《侠客行》第一章是这么写的:
汴梁城外的一个小镇,暮色时分,四围响起了马蹄声,由远而近,浩浩荡荡,没人知道出了什么事情。——这时,金庸把笔锋宕开,写镇上人的各种惶恐不安,战战兢兢,于是小镇气氛更加凝重紧张。紧接着,马蹄涌入城内,一帮凶神恶煞的人列队排开,当中一人穿着皮靴踏着石板路走来…… 整个暮光下的小镇上,唯一的声音是他的皮靴声。唯独有个卖饼老汉,依旧做烧饼,对一切置若罔闻。此人不忿上前,卖饼老汉顺手把他灭了。可是,一个冷眼旁观的老者周牧又站出来,把卖饼老汉解决了。而周牧见了安金刀,却远不是安金刀对手。这时,石清闵柔出现了,果断把安金刀打趴下了…… 然后,谢烟客闪亮登场,前边的所有人物,一概变成了小喽啰……
以上,就是一段很好的代码。好在哪里?好在语句间的关系清晰明了,好在各变量和函数定义得一丝不苟。所有的语句之间,层次条理极为鲜明。一个语句是一个语句,一个函数是一个函数。不粘连,不纠结。每段代码要解决什么问题,别人一看就知。不是所有代码混成一锅粥。各小段代码单独拎出来,各各是独立的,各各都好看;但在总体上,又能形成一股合力,指向问题最终的解决。
文章也该这么写。轮到每个配角的戏份时,要当成主角去写,同时,所有的戏份从整体上看,又要层层递进。文章各段落之间也要形成一股合力,每个小段落既能单独拎出来成立,还要成为整篇文章的一块砖,不能率尔删去。若前者做不到,文章就太粗糙不够细腻,若后者做不到,文章就沦落成了段子集。
好的文章也如此,它一定不是单线程的,必然是多线程的。所谓多线程并不是指存在多个主题,它仍然是一个主题和中心,但它蕴藏着多种内涵和意义,所有内涵又必须是统一在大主题之下的。
像《天龙八部》这部大作品,就极具复杂性。因为过于复杂,整个前15回都是在界定关系、建立模型,除了少林之外,几乎所有重要的函数和模型,都在前15章定义清晰了。
但变量并没有全数出现。因为有些变量必须到问题复杂到一定程度才能定义。主要人物中,萧峰到了第14回才出场,虚竹到了29回才出场,萧峰出场前已经有了30万字,虚竹出场前已经有了60万字。直到40回后,少林寺大会才将整部小说推向大高潮。少林寺那段之所以是大高潮,是因为在那个模型里,几乎所有的变量、函数、模型都包含进来了,而没有一个是之前未精确定义过的。
可见,金庸笔下的复杂场面是龙须面,虽细,但一根是一根,根根拎得清。换个人写,就坨成一坨了。
以上,是良好的代码风格在写作上应用的一些简单探讨。
但需要说明的是,并非所有的好文章代码风格都好。也有一些大牛作者,代码故意晦涩,却被尊为圭臬。像周作人的散文,陈散原的诗就是。——老子就是不友好,爱咋咋的。别人写代码,尽量把句子拆短,他却三五行代码硬是拧成一行。他要的就是这个效果。他的着眼点不是复杂问题的清晰解决,而是解决思路的别致性。这是另一种风格,本文就不细表了。
例如,变量的命名。像本文,如果叫《论良好的代码风格》,姿态就不佳,一个“论”字就让读者反胃了。如果叫《如何写出良好风格的代码》,太装了,好像自己是编程大师似的。换一种叫法,《扯扯良好代码风格的淡》,感觉就亲民多了。
不过,本文也没那么叫,因为作者不忍心欺负程序猿。程序猿是很实诚的物种,被题目忽悠进来,发现作者根本不懂编程,就会愤怒得跟猩猩似的。
閑话休提。说到变量命名,金庸就是个中高手。像四大恶人的外号:恶贯满盈,无恶不作,凶神恶煞,穷凶极恶——同类型变量中包含特定的元素,一看就记住了。再比方,穆念慈和包惜弱,这两人从未谋面,名字却是工稳的对仗,暗指二人是母女关系:穆念慈的“慈”,就是一个指针指向包惜弱,包惜弱的“弱”也是一个指针指向穆念慈。慈就是母,弱就是子嘛。
《侠客行》开头有个“卖饼老者”,卖饼老者有没有名字呢?有,叫吴道通。那金庸为什么不直接称呼他“吴道通”呢?答曰:占用内存。读者记太多名字会累的,哪怕名字都是丁不三、包不同这种,多了也记不住。一个无名小卒,戏份太少,特地安个名字不划算。名字相当于一个指针,读者看到名字,首先想到这个人的特征和身份,才明确这个人。对于戏份太少的角色来讲,变量不存在多次赋值的问题,安排指针是大大的浪费。
但金庸还是说出了他的名字,不过金庸并不是直接以叙述的方式告诉读者他叫吴道通,而是通过他的对手骂他:“姓吴的,你想怎样……吴道通,你到底要怎样……”接下来,就自然替换成吴道通了。为什么又要替换呢?因为紧接着出现了第二个“老者”,若不替换,这老者和那老者就犯了重名的问题。可见,“老者”其实相当于一个局部变量。同样,“胖子”“店小二”也是。
《侠客行》第一章是这么写的:
汴梁城外的一个小镇,暮色时分,四围响起了马蹄声,由远而近,浩浩荡荡,没人知道出了什么事情。——这时,金庸把笔锋宕开,写镇上人的各种惶恐不安,战战兢兢,于是小镇气氛更加凝重紧张。紧接着,马蹄涌入城内,一帮凶神恶煞的人列队排开,当中一人穿着皮靴踏着石板路走来…… 整个暮光下的小镇上,唯一的声音是他的皮靴声。唯独有个卖饼老汉,依旧做烧饼,对一切置若罔闻。此人不忿上前,卖饼老汉顺手把他灭了。可是,一个冷眼旁观的老者周牧又站出来,把卖饼老汉解决了。而周牧见了安金刀,却远不是安金刀对手。这时,石清闵柔出现了,果断把安金刀打趴下了…… 然后,谢烟客闪亮登场,前边的所有人物,一概变成了小喽啰……
以上,就是一段很好的代码。好在哪里?好在语句间的关系清晰明了,好在各变量和函数定义得一丝不苟。所有的语句之间,层次条理极为鲜明。一个语句是一个语句,一个函数是一个函数。不粘连,不纠结。每段代码要解决什么问题,别人一看就知。不是所有代码混成一锅粥。各小段代码单独拎出来,各各是独立的,各各都好看;但在总体上,又能形成一股合力,指向问题最终的解决。
文章也该这么写。轮到每个配角的戏份时,要当成主角去写,同时,所有的戏份从整体上看,又要层层递进。文章各段落之间也要形成一股合力,每个小段落既能单独拎出来成立,还要成为整篇文章的一块砖,不能率尔删去。若前者做不到,文章就太粗糙不够细腻,若后者做不到,文章就沦落成了段子集。
好的文章也如此,它一定不是单线程的,必然是多线程的。所谓多线程并不是指存在多个主题,它仍然是一个主题和中心,但它蕴藏着多种内涵和意义,所有内涵又必须是统一在大主题之下的。
像《天龙八部》这部大作品,就极具复杂性。因为过于复杂,整个前15回都是在界定关系、建立模型,除了少林之外,几乎所有重要的函数和模型,都在前15章定义清晰了。
但变量并没有全数出现。因为有些变量必须到问题复杂到一定程度才能定义。主要人物中,萧峰到了第14回才出场,虚竹到了29回才出场,萧峰出场前已经有了30万字,虚竹出场前已经有了60万字。直到40回后,少林寺大会才将整部小说推向大高潮。少林寺那段之所以是大高潮,是因为在那个模型里,几乎所有的变量、函数、模型都包含进来了,而没有一个是之前未精确定义过的。
可见,金庸笔下的复杂场面是龙须面,虽细,但一根是一根,根根拎得清。换个人写,就坨成一坨了。
以上,是良好的代码风格在写作上应用的一些简单探讨。
但需要说明的是,并非所有的好文章代码风格都好。也有一些大牛作者,代码故意晦涩,却被尊为圭臬。像周作人的散文,陈散原的诗就是。——老子就是不友好,爱咋咋的。别人写代码,尽量把句子拆短,他却三五行代码硬是拧成一行。他要的就是这个效果。他的着眼点不是复杂问题的清晰解决,而是解决思路的别致性。这是另一种风格,本文就不细表了。