如何编写高质量的代码

代码如人。

代码如物。

如人，美女和帅哥总是受人欢迎，而后人们才看他内心是不是善良，是不是有能力。

如物，人们总是先看这个物体又没有美感，然后再看它实用不实用。

因此，高质量的代码也分两方面：外表和内在。

从外表上看，代码排版美不美，也就是有没有正确的缩进，空行和空格的放置是否合适等。

美的代码不一而足，不美的代码都差不多。

比如缩进，一般为两个或四个空格，太多了也不好看。不缩进，代码就成了现代散文。

又如，一行代码的长度要适中，太长，一行代码拐了N个弯，肯定无美感可言。

又如，变量名长度要适中，太长，写着费劲，看着也费劲。太短，又不知所云。所以要看作用域。作用域越小，变量名越短，作用域越大，变量名越长。

又如注释，注释太多，犹如杂草丛中找禾苗，反而扰乱了视线。注释太少，在复杂之处又让人难以理解。所以，要从维护的角度写注释，简单之处无需注释。复杂之处要注明为什么，必要时附上参考文献的链接。

内在的美，要看解决问题的逻辑是否清晰，实现是否优雅。

比如，模块化设计或分层设计的运用是否得当。如果没有分层设计，扑面而来的就是一堆实现的细节，又是for循环，又是公式计算，让人看了不明所以。美的代码要分层。顶层代码如文章，通过函数名就知道是干什么了。外行人都能看得懂。而将细节封装于底层，也有利于做单元测试。

有时也要看针对问题的选用的数据结构。数据结构选对了，思路就顺畅，选的不合适，实现起来就别扭。

因此，扎实的基本功，对问题不断深入的理解，适时的代码重构，是提高代码质量的关键。

来源：一分钟说软件