问提高代码可读性

EN

查看Jeff的代码嗅探博客文章。差不多可以概括一下。当涉及到可读性很好的代码时，我将添加我的个人精神：

• 一致性：--这适用于格式化、使用大括号、命名(变量、类、方法)和目录布局(如果您将一个源目录埋在/css下的某个位置，我将用砍刀跟踪您)；
• 大小：--如果一个函数在屏幕上不适合正常字体大小的普通IDE，那么您需要一个很好的理由来解释为什么不这样做。当然，对于长得多的函数，也有一些有效的例子，但是它们被那些令人震惊的例子远远超过了。必要时分解，使您的功能保持简单；
• 注释明智地：有些程序员倾向于使用注释代替可读的代码，或者只是为了注释而进行注释(就像return true;前面的/* finished */注释一样)。说真的，有什么意义？大多数(好的)代码自己解释；
• 从不在项目中剪切和粘贴：从一个项目获取一个代码片段到另一个项目(每个项目都是一个孤岛)是完全可以接受的，但是您不应该将一个不平凡的代码片段从一个项目中带到项目中的另一个点。不可避免地会发生变化，您会让一些可怜的开发人员负责查看这两个或多个代码段，试图找出它们是如何不同的(更重要的是，为什么)；以及
• 避免重复代码：--如果您发现自己一遍又一遍地编写相同的语句序列(或非常相似的语句)，那么将其抽象或参数化。如果你看到非常相似的陈述，倾向于浏览它们，假设它们都是一样的(通常情况下，它们不会在某种程度上重要)。

• 一致格式样式
• 很好地利用空白
• 使用简短但有意义的名称
• 没有太多的注释(正如您提到的那样)，但是当我这样做时，注释代码的whys，如果适用的话，注释-- nots (为什么没有使用其他实现，尤其是如果这样做看起来应该很明显的话)。
• 不要优化代码，直到分析器告诉我它的缓慢或低效。

使用好的变量和方法名称。将代码分解为实现特定目的的有意义的部分。保持类的内聚力(所有的类一起工作)和解耦(类之间几乎没有依赖关系)。不要重复(干)。遵循Bob叔叔的固体原理 (不是法律，就像他指出那样)，让代码变得更好。