年轻程序员需要学习的5大经验_重命名

名不副实的函数/变量/类

这些函数、类和变量实际所做的事与其名字所表达的含义并不一致。片面看名字是正确的,但是联系实际的话,有的甚至是毫不相关的。

举个例子,我上一期的实习生写了两个类:EditorGUI和EditorObjectCreatorGUI。用于处理编辑界面的代码。让我哭笑不得的是,用于创建新对象的是EditorGUI,而EditorObjectCreatorGUI只能通过处理不同的对象进行导航。两者的含义居然是截然相反的!即使代码还算相对简单,但我还是花了相当长的一段时间用来理解它,因为一开始我是在一种完全相反的假设基础上来理解的。这种情况的解决方案非常简单:重命名EditorObjectCreatorGUI为EditorObjectNavigationGUI即可,这样就易于理解多了。

这种情况我看到过很多。之所以会发生这种情况是因为代码在工作过程中发生了演变。在选择名字的时候可能还是正确的,但到了写完代码的那一刻,就名不副实了。关键是要时刻铭记命名法则。你得明白你添加的东西是否依然符合函数和类的名称。

混乱的类

另一个问题是类很乱:类做了很多不相关的事情。新功能的添加很简单,但是慢慢的,你会发现你的代码变得臃肿不堪,各种不相关的功能随处可见。有时候,臃肿与否也并不指的是类的大小:某个类可能只有几百行,但依然囊括了不属于它的代码。

为什么会发生这种情况呢?举个例子:假设由于某种原因,某个GUI类需要分析什么样的纹理可行(可能是有按钮要用来选择纹理)。如果这个GUI类是唯一需要这个分析结果的类,那么在GUI类中这样做是有意义的。然而,由于某种原因,一个完全无关的gameplay类也需要这些信息。所以你需要将这些纹理查询的信息从GUI类传给gameplay类。这时候,其实这个GUI类已经变大了:因为它里面其实还包括了TextureAnalyser类。解决方法也简单:将TextureAnalyser类分割为一个单独的类,GUI类和gameplay类都可以使用它。

关于这一条经验法则很多人提出质疑:要是我添加的功能仍然适合原来这个类的名字呢?如果的确不适合,那么我就必须重命名,或者将其分割成单独的类,抑或用代码写成一个不同的类吗?

如果你不能为你的类想出一个合适的名字,给人的感觉就会不舒服。如果你不能在类的名字中描述它的目的,那么就会显得乱七八糟。有时候我们还需要将某个臃肿的类分割成几部分,并各自取一个恰当的名字。

过于庞大的类

这和上一点——混乱的类有些类似:很多东西一点一点地都添加到类中,然后它不可避免地就臃肿了。在这种情况下,这样一个类仍然是有意义的,但就是长得太大个了点。这么个庞然大物不但繁琐,而且很容易出现bug,因为大量的代码需要用于操作同一个私有成员变量,所以我们很容易忽视一些细节。

分割一个已经长得很大的类其实是相当枯燥的。这也会成为一个挑战,如果类中的代码高度交织在一起的话。再加上它已经在工作,修复时不能添加新功能,这样一来,我不得说,分割一个过于庞大的类,不能严格地自我规范是不行的。

根据在Ronimo的普遍经验,类保持在500行代码以下、函数保持在50行代码以下是最合适的。不过有时候,这样做反倒不可行,也不明智。但是一般说来,一旦类或函数超出了那个界限我们就可以想办法重构,并将之分割为更小更易于管理的片段了。

关于代码注释

几乎所有的示例代码都会包含注释好了的代码片段,而不说明为什么。这段代码需要修复吗?旧的代码是否已经被取代了?为什么那儿要写这些代码?大家都知道没有注释的代码常常不知所言,但不知何故,很多人都会忘记在自己的代码上注释。