你第一眼看到这个标题可能会疑惑我的标题是不是写错了，那么我来解释一下，第一个“写好代码”的“好”是副词，而第二个“写好代码”的“好”是形容词。意思就是只有你把代码写好了，你的代码才称得上是好代码。

那么如何写好代码呢？上周我在我的开发小组内进行了一个有关于整洁代码主题的分享。在这个分享上，我强调了一个中心思想，什么样的代码才能称作好代码，就是能让别人看懂的代码。而这个并不是一件容易的事，前人在这个思路下已经总结了一套原则出来，于是才有了《代码整洁之道》这本书来讲怎么把代码写的整洁，代码写的整洁了，别人也就越能读懂你的代码。

为什么说让别人读懂你的并代码不是一件容易的事呢？那是因为每个人有自己的主观能动性，你觉得别人能看懂，其实仅仅是你以为的而已。所以，有必要有一些规范来指导我们怎么写出让别人能读懂的代码。以下是我读《代码整洁之道》的一些体会。

命名

首先命名是贯穿我们编码始终的一件事。我们给变量、函数、参数、类和封包命名。我们给源代码及源代码所在目录命名。我们给jar文件、war文件命名。我们给一切命名。一个好的命名能让别人见名知意，要让别人看懂你的代码，首先就要做到命名准确、达意。

函数

前面讲到命名，那么函数的第一步也是命名。函数的命名通常是动词或者动词短语，它是对一系列操作的抽象。但是这一系列操作只做一件事，不然它也不能用一个动词或动词短语表示。所以这就是让别人读懂你的代码的关键，也就是把一些细节隐藏，只用一个动词或动词短语代替，这也就是封装的好处。这样就能让读你代码的人一开始不用纠结于细节，而通过读那些函数名就能知道代码干了什么。

注释

很多人的第一印象是注释必须写的多，在有些国企，甚至硬性要求代码的注释量要达到整个代码量的30%。可在我看了这本书后才发现，注释并不是写的越多越好。因为尽量减少注释，能够倒逼你写好代码、写出整洁易读的代码。而且注释不总是会随着代码走，当你忙着救火的时候，哪有空去维护注释，所以注释会随着时间的拉长变得越来越没用，所以就得尽量用代码本身把逻辑表达明白。我们也别妄想通过注释掩盖自己代码的不清晰，我们要尽量把代码写的就像一篇散文一样，已经不需要多余的文字去解释它了。如此而来，代码是不是更好读了呢？

当然，我只读了前面几个章节，不过这已经足够我们平常开发使用了。下次，在你想写好代码的时候，就可以看看我这边总结的几个小原则。

---