提高程序可读性

提高程序可读性

点开这篇文章，意味着你有想成为更好的程序员的决心，那么请认真阅读以下内容：

在编程过程中注意提高程序的可读性是良好的编程习惯，这使程序更易于理解，也更容易在以后进行修改和更正。同时也有助于我们理清自己的编程思路。

为了避免步入代码的wading，可读性是必要的。代码不仅追求效率，也追求优雅，也即“干净利落的抽象”——crisp abstraction（出自Grady ，《面向对象分析与设计》作者)

否则可能应了那个程序员界的冷笑话：

你刚写完这个程序的时候，只有你和上帝知道是什么意思；一年以后，只有上帝知道了。# =.=)

以下是一些能够在编程中有效提高可读性的手段：

技巧1：关于命名

1）有意义的命名

进行名副其实的命名，而不是使用无意义的随意的名字，这种规则包括但不限于变量名、函数名、类名、文件名…否则毫无章法的名字会是读到代码的人产生疑惑，甚至你自己以后重新检查代码时也会陷入迷茫。

其难处在于需要良好的描述技巧，精准的用词（尤其是我们对英语的掌握可能不那么精通的时候）

最基本的是：不要简单的使用a,b,c,d去命名变量！

2）避免误导

不要给变量等起一个可能被人误导的名字。

譬如不要用 accountList 来表示一个账号，除非它真的是一个 List，若所用容器不是list，可能会引起一些错误的判断。

还有不要用小写l, 大写O直接作名字，因为它们和数字0 1很像==

3）经典命名法

关于经典命名法可以参考如下文章，其中详细列举了匈牙利、驼峰、帕斯卡命名法

经典命名法介绍

技巧2：适当注释

恰到好处的注释可以省下许多力气，你懂的

p.s.该技巧与 技巧1 在实际编写代码时应该综合应用，相得益彰，避免重复啰嗦，要减少不必要的注释。

技巧3：函数的使用

1）减少嵌套

多层嵌套会大幅度降低程序的可读性，我们可以借用函数来减少嵌套

2）避免重复

重复的代码块可能意味着某种想法未在程序中清晰的表达出来，这也削弱了代码的可读性。

利用函数包装重复代码块，可以使程序更整洁

3）代码模块化

当代码量比较大时，对代码进行模块化，根据各个部分的不同功能进行打包区分，包进函数里，可以使程序看起来整齐有序，提高可读性。

技巧4：给代码分块

利用空行分隔多个部分，使程序的步骤序列一目了然，显得结构清晰，也便于作者的整理思考

技巧5：格式

注意良好的缩进格式等；遵守主流代码风格，不要另辟蹊径，

譬如：不要把你的代码的几句放在一行里或者把一句拆成一行以上！！

int 
num = 3
;//case 1

int num = 9; printf("%d", num); return 0;//case 2

最后

正如《代码整洁之道》一书中的“花时间保持代码整洁不但有关效率，还有关生存”，毕竟混乱会导致团队生产力下降，又制造更多混乱，最终效率趋向于零…

因此，在编码过程中注意提高程序可读性就显得至关重要。not necessary elegant, but always clean and tidy

​