内容均来自于代码简洁之道

一、代码整洁的5s哲学

• 整理：搞清楚事物之所在——通过恰当地命名之类的手段——至关重要。
• 整顿：A place for everything,and everything in its place。每段代码都在希望它所在的地方—— 如果不在，就需要重构
• 清楚：对于各种遗弃的待注释的代码以及反映过往或期望的无注释代码，处之而后快。
• 清洁：标准化。组内实行统一风格，统一编码。
• 自律：在实践中贯彻规程，并时刻体现于个人工作上，而且乐于改进，其实就是不断重构的过程。

二、命名的哲学

<b>命名是程序中随处可见的，好的命名规则能使代码优雅和易读</b>

• 名副其实：我们应该可以清晰得从代码的名称中体会到其左右。
• 避免误导：避免使用与本意相悖的词。
• 做有意义的区分：别仅仅为了满足编译器或解释器去写代码。名称相异的变量其意义一定相异。不要因为变量重名而错误得起名字或起相同的名字来代表不同的意义。
• 使用读得出来的名称： 用能读出来的单词来进行命名。
• 使用可搜索的名称：用可搜索的名称来代替数字或者字母，名称长短应与其作用域大小想对应。
• 避免使用编码：不要用匈牙利编码；成员变量不要加前缀；接口前不要加I，而接口名+imp。
• 避免思维映射：明确是王道，别用自我的思维去命名。
  <b>接下来是对类名的命名</b>
• 类名：名词或者是名词短语，不能是动词。
• 方法名：动词或者是动词短语。
• 每个概念对应一个词：给每个抽象概念一个词，并且一以贯之。
• 别用双关语：即一个方法名字（或者是名字之中的一部分例如add），只对应一共功能，不能add又涉及加入又涉及插入。
• 使用解决方案领域的名称：尽管用计算机科学的名字。
• 添加有意义的语境，不能添加无意义的语境。

三、函数

• 短小，比短小更短小。函数就该小粒度。if语句、else语句、while语句等，其中的代码应该只有一行，大抵是一个函数调用语句。
• 函数应该制作一件事，做好一件事。函数中的语句应该在一个抽象层级上。让代码具备自顶而下的代码阅读顺序。
• switch尽量隐藏到底层的代码中，而不是恐怖的代码展开。
• 使用描述性名称，让函数可以从名称中了解到含义。
  <b>函数的参数，最理想的是零参数函数，其次是一参数函数，再次是二参数函数。尽量避免三参数函数，只有有足够特殊的理由才可以使用三参数函数。</b>
• 一元函数使用的理由应该由以下来决定：有可能是询问关于参数的问题；又有可能是操作该参数，又或者是告知系统发生事件。一元函数的标识参数最好不要使用，标识参数告知本函数做的事不只意见，这就违法了上述的单一性原则。最好是一分为二去做。
• 二元函数，在参数单个值的有序组成部分的时候比较适合。但应该尽量将二元函数转化为一元函数。
  其他还有一些建议：
• 函数应该无副作用，不应该在一件事情的完成下，包含另一个事件的状态的变更。
• 分隔指令和询问。指令应该干的事和询问应该干的事不同。二者不可兼得，药么函数做了什么事，药么函数是回答某个问题。
• 函数的返回值如果是错误码的话，我们应该用异常区替代，这样不会造成深层次的嵌套和错误处理。
• 抽离出try-catch处理块，错误处理函数只应该做一件事。
• 别重复代码。