如何改良你的程序代码质量的11个技巧

发表于:2013-01-18来源:外刊IT评论作者:不详点击数: 标签:代码
如何改良你的程序代码质量的11个技巧!有很多理由都能说明为什么我们应该写出清晰、可读性好的程序。最重要的一点,程序你只写一次,但以后会无数次的阅读。当你第二天回头来看你的代码时,你就要开始阅读它了。当你把代码拿给其他人看时,他必须阅读你的代码。因此,在

  有很多理由都能说明为什么我们应该写出清晰、可读性好的程序。最重要的一点,程序你只写一次,但以后会无数次的阅读。当你第二天回头来看你的代码时,你就要开始阅读它了。当你把代码拿给其他人看时,他必须阅读你的代码。因此,在编写时多花一点时间,你会在阅读它时节省大量的时间。

  让我们看一些基本的编程技巧:

  尽量保持方法简短

  永远永远不要把同一个变量用于多个不同的目的

  使用自描述的变量名和方法名

  尽可能的把变量定义在靠近使用它的地方

  拒绝神秘数字

  友好的对待你的语言

  不要逆常规而行

  警惕过早优化

  积极重构测试过的程序

  不要过度沉迷于技巧

  通过习例学习新知

  现在,让我们把每个小点展开来详细讲一下。

  1. 尽量保持方法简短

  尽管很多人都遵循这个规则,但它仍然非常的重要。你写的方法要始终能在一个屏幕里放得下。如果你需要去滚动屏幕,这会分散你的注意力,而且你看不到整个的上下文。最佳长度是5-20行,这根据你的情况而定。当然,getters/setters 通常是一行代码的方法,但与其说它们是真正的方法,不如说它们只是存取工具。

  2. 永远永远不要把同一个变量用于多个不同的目的

  一个变量应该始终只为一个目的服务。通过使变量常量化(C++里的const, Java里的final),使得编译器能够优化编译,而且使你的代码醒目表达这个变量是不能改变的,你的程序的可读性会变得更好。

  3. 使用自描述的变量名和方法名

  你的代码应该,对于任何人来说,只要看一眼就能知道是干嘛的。尽量不要用简写方式,除非有特殊的习惯,就像下面的:

  src - source

  pos - position

  prev - previous

  如果你认为描述性的名称并不是那么有价值,请对比一下n, ns, nsisd 和 numTeamMembers, seatCount, numSeatsInStadium。

  4. 尽可能的把变量定义在靠近使用它的地方

  盖房子时,你可不希望把锤子放到别人的院子里。你希望把它们放的离手头越近越好。定义变量也是同样的道理。

  int foo = 3;

  int bar = 5;

  // 一大段使用“bar”的代码,

  // 但没用到“foo”

  // ...

  baz(foo);

  这段代码可以简单的重构成

  int bar = 5;

  // 一大段使用“bar”的代码,

  // 但没用到“foo”

  // ...

  int foo = 3;

  baz(foo);

  当你把变量的声明和第一次用到它的地方间隔太远时(距离超过一个屏幕),这确实会成为一个问题。记住上下文关系会变得困难,你需要滚动屏幕去找哪来的这个变量。

  5. 拒绝神秘数字

  当你要把什么东西跟一个常量值做比较时,记得把这个值定义成常量。没有什么会比去猜测你的同事写的这样的代码更让人头疼的事了:

  il < 4384

  换个形式感觉如何?

  inputLength < MAX_INPUT_LENGTH

  6. 友好的对待你的语言

  学习新语言是一种很有乐趣的事情,你能学到一种新的完成任务的途径。当一个对一种语言已经很专业的人去学习另一种语言时,会出现一种很大的负面效应。比如说你是一个Java开发者,试图去学习Ruby。你应该学会用Ruby的方式解决问题,而不是沿用Java的解决问题的思想。

  当你需要重复5遍”Hello world!“时,在Java里,你可能会这样做:

  for (int i = 0; i < 5; i++) {

  System.out.println("Hello world!");

  }

  在Ruby里,你也许会禁不住这样写:

  for i in (0..5)

  puts "Hello world!"

  end

  这样看起来没问题,但有一个更好的方式:

  5.times { puts "Hello world!" }

  7. 不要逆常规而行

  每种语言都有自己不同的习俗约定。一般来说,人们听的最多的是Java的编码规范。让我们看看其中的一些习俗规范:

  方法名应该小写字母开头,其后用字母大写的单词连接(veryLongVariableName)

  类名应该都使用首字母大写的单词连接而成

  常量名应该全部大写,用下划线连接(MY_CONSTANT)

  左大括号应该跟 if 语句在同一行

  只有在有必要的理由时才去打破这些常规,不要轻易的因为你不高兴就违反它。如果你只是在团队里改变一些这样的习惯,那也没问题,但当把你代码拿出来和其他的没有这些思想准备的程序员共享时,问题就会来了。

  8. 警惕过早优化

  过早优化是所有问题的根源,至少电视上是这么说的 … 你第一应该关心的事情是写出易于理解的代码。起初写的程序不要求快。除非你的程序很慢,否则谈优化都是为时太早。如果你想优化什么东西,你首先需要知道问题出在哪。这就是我们需要profilers这个工具的原因。

  在没有知道问题在哪的情况下试图对程序进行优化,其结果必然是把程序能坏,至少你的代码会丧失可读性。如果你觉得有些地方很慢,不要盲目的重写代码,你应先找到慢的证据。

  不要傻乎乎的去解决根本不存在的问题。

  9. 积极重构测试过的程序

  没有任何东西会是完美的。即使你感觉你真正写出了一段完美的代码,几个月后回头再看看,你可能会惊讶道”怎么会这样傻?“

  改进程序的一个好方法就是重构,但要等程序测试通过之后。你首先要确保程序是好的可运行的,你可以通过自动化测试或手工测试完成这个工作。

  之初,你需要的是程序可用。不要期望在第一次就写出完美的程序,你只需要把它写出来,可用。然后重构它,使之完美。对于你们当中知道测试驱动开发(TDD)的人来说,对这个会很熟悉。这里的关键就在于你要习惯于重构这种事情。如果你使用的是像IntelliJ IDEA这样强大的集成开发工具的话,重构的工作会变得简单的多。

原文转自:http://www.aqee.net/11-tips-for-better-code/