如何写好代码系列——第二期，以作者的角度去看待你的代码

我们是作者

我们是作者，这一点在JAVA DOC中的@Author注解也可以看得出来。既然有作者，就一定会有读者，所以我们要摆正自己的位置，不要以为自己代码的读者仅仅就是计算机。事实上绝多大多数的时候，我们都会去阅读到别人的代码。试想一下，当你看见一个方法几百行，里面嵌套n个for循环和m个if判断的时候，你还有耐心一行一行的看下去吗？那么问题来了，如何在代码实现结果不变的情况下，去变成一个好的代码了？其实我们可以类比一下那些长篇小说。

长篇小说是怎么做的

第一点、分篇章

一部小说，基本上不会是从头一直讲到尾。一般来说，都会分成多个小的章节，甚至分成几本书。这样做的好处：
1、能让读者明确的知道这个章节甚至这本书主要讲的是什么内容；
2、能让作者更加专注的写好本章节。
3、使得文章更具连贯性，一气呵成。
对比我们的代码，实际上也就是类的边界。一个类不应该有太多的职责，他只需要做好他自己的本质工作即可。对于程序员来说，专注于实现一个功能或者一个需求，出错率会更低而效率也会更高。太过臃肿的类不仅仅让读者不知道作者的真实意图，也会让类本身造成大量的耦合，可维护性和可拓展性就低得可怕了。

第二点、表达清晰

一篇好的文章，会给读者清晰的表达出作者想要表达的意图。在代码层面，写代码的人就是作者，其他开发人员可以理解成读者。我们在写代码的时候，往往只会考虑针对于自己的可读性。自己倒是写得爽了，这样的问题就是别人看你的代码就像是在做翻译一样，甚至是哪天你要是请假休息，你负责的代码不出问题倒还好，一出问题就会电话爆棚。

第三点、用词准确

用词准确这个很重要，词不达意带来的后果往往特别严重。古代的诗人为了“吟安一个字”而“捻断几茎须”,现代的作家也精心锤炼词语，力求找到能最准确地表情达意的词语。当然对于我们程序员来说，要求并没有这么苛刻，但是取一个合格恰当的用词还是必不可少的。用词不准确这样的问题在代码里面还是比较常见。在程序代码里面，用词的地方比比皆是，类名、方法名、变量名，一个好的名字能大大减少开发者的沟通成本，

第四点、必要注释

注释这个就很好懂了，作者担心部分读者对某个片段有不理解的地方，就会加一个注释来详细解释一下。放在代码层面，相信大家都不会陌生，但是我本人并不认为在代码中满篇的注释就是一个优秀的代码。真正优秀的代码，是不需要大量的注释，这个我会在后文中阐述我的观点。

同为作者，我们又有哪些不一样呢？

请记住一点：我们虽然是作者，但也绝不是散文作者！！