如何写好代码系列——第三期，以说明文方式去写你的代码

以说明文的方式去写你的代码

文章的表达方式这么多，为什么要以说明文呢？我们可以先来看一下百度百科上对说明文的解释。

说明文是一种以说明为主要表达方式的文章体裁 [1] 。对客观事物做出说明或对抽象事理的阐释，使人们对事物的形态、构造、性质、种类、成因、功能、关系或对事理的概念、特点、来源、演变、异同等能有科学的认识，说明文的中心鲜明突出，文章具有科学性，条理性，语言确切生动。它通过揭示概念来说明事物特征、本质及其规律性。说明文一般介绍事物的形状、构造、类别、关系、功能，解释事物的原理、含义、特点、演变等。说明文实用性很强，它包括广告、说明书、提要、提示、规则、章程、解说词等。说明文有的是以时间为序，有的是以空间为序；有的由现象写到本质，有的由主写到次；有的按工艺流程顺序来说明，有的按事物的性质、功用、原理等顺序来说明。

是不是感觉跟我们的代码特别相似，对于代码来说首要条件肯定是为了实现功能，但是作为一个有追求的程序员，仅仅是实现功能并不能证明自己的强大，就像小学生的文章一样，仅仅是交代了事情的起因经过结果，一个方法千行代码，估计连作者本身都看不下去。
既然都说了，要以说明文的方式去写代码，那么我们到底怎么去写呢？结合一下说明文的特点。

1、内容是具有高度的科学性
什么是科学，我认为科学就代表着严谨。你不能让一个对象引用，上一秒是“猫”对象，下一秒又是“狗”对象，可能过一会又成了“鱼”对象，这样会让“阅读”的人感到十分困惑，即使这样的操作在JAVA语法上是允许的。

2、结构上具有清晰的条理性
这个其实很好理解，逻辑清晰对于一个程序员来说至关重要。混乱的逻辑意味着混乱的代码，代码的先后顺序可能对结果产生不了影响，但是正常人在阅读的时候是从上往下的结构，清晰的条例能让阅读者更好的理解作者的意图。

3、语言上具有严密的准确性
这个对应的就是类、方法、对象的命名是否准确了。有过几年开发经验的人往往都知道，很多时候，我们并不会去关注代码的细节，往往就是通过各种名称来大致判断这段代码的作用。一个名称命名是否准确，很大程度上能左右一个BUG修复的时间。命名对于开发者来说，是必须掌握的东西，也往往能反应出这个开发者的水平高低。

所以，请以说明文的方式去写你的代码！！