1:保持类最小。
2:保持方法最小。运行时效率不是要具有小方法的原因,可读性才是真正的目标。这将使得代码更加容易维护,并且在需要添加功能时更加容易更改。
3:给方法取好名称。揭示意图的方法名。
4:保持类的数量最少。如果需要,就可以添加一类;不要为了加类而加类。
5:保持注释的数量最少。注释使代码维护变困难,如果想更改代码,就必需要先修改注释,否则注释会可怕地过期,这样会使维护的时间加倍;如何解决?如果代码太难阅读和理解而需要注释,我就需要使它足够清晰,从而不需要注释;如果代码太长,或者做太多的事情。我就简化它;如果代码太隐晦,就添加助手方法,使之清晰。保持代码清晰!如果您需要系统或者某个特定组件的全景描述,就编写一个简短的注释来描述。
罗嗦的注释一般比较难维护,通常不及一个小的、编写良好的方法那么好地表达意图,并且很快就会过期。根本不要过分依赖注释。
6:使用一致的风格。惟一绝对的风格规则是
一致性。如果一个项目上的每个人都用不同的风格,那么阅读代码将变得很困难。挑选一种风格并且不要改变。
7:避免switch。
8:使方法是 public
的,变量是 protected
的,直到您有一个很好的理由限制访问。如果您对代码中您设想其他人不应该访问的东西限制访问,您就是在设想自己无所不知。这在大多数时候是一个危险的假设。不要以“这段代码不应该被调用”、或者“没有人会用这段代码”为理由气绝将代码设为public。