重视代码的整洁性

如今,新的程序员不断地向编程界涌入,软件开发也比以前更加科学而快速.但一个软件项目的生命周期对于程序员来说都清楚不过,然而不少人都忽略了后期的维护与扩展.为了缩短整个软件项目的开发周期,方便后期的维护与扩展,我们就必须重视代码的整洁度,写出酷码来.编程就像是写文章,你写出的代码必须得让其他程序员看得舒心,让读者对你写代码内容一目了然,在最短时间内明确你写的代码的目的.

我们编程时的大部分时间花在了阅读代码上,只有阅读了已有代码,明确已有代码的结构和意图之后,我们才能接着编写程序.既然大部分时间花在了阅读代码上,那么我们就必须在阅读代码上减少所花费的时间.因此,我们一开始就得写出整洁的代码,方便以后的修改.那我们该如何写出整洁的代码呢?这个问题可以好好参考一下Robert C. Martin的<Clean Code>.

所谓的整洁代码是:以最为明确的方式表明代码的意图,让人阅读起来赏心悦目.下面总结一下三个最为常用的整洁要点:

一.命名

1.命名必须简明.即意思明确,无歧意.而且不使用相似的字符(比如数字'1'与字母'ｌ').

2.命名必须使用读得出来的名称.

3.为了让IDE帮助你查找,所命的名字必须是可搜索的.

4.尽量不去使用前缀.

5.尽量使用与当前软件项目相关的名称.

6.添加有意义的语境.

二.函数

1.函数应该尽量短小,一般不要超过一屏.

2.函数应该只做一件事.

3.每个函数最好只有一个抽象层级.

4.函数参数个数应该尽可能少.

5.多使用异常来替代返回错误码.

6.不要重复自身.

三.注释

1.尽量通过代码来表达自己的意图,而不是总通过注释.因为在开发过程中,我们在修改了代码之后就忘记去修改注释,从而导致注释与代码的意思不一致.

2.看到注释掉了的代码应该立马删除,绝不留情.

3.注释不要去包含作者等那些能被代码管理仓库所能管理的信息.

4.对于法律信息,代码意图,给其他程序员的警示等信息有时应该加上注释.

5.注释中绝不加多余的话,费话,误导性语句.

6.注释中不能去包含与当前代码相关性不大的语句.