总结代码整洁之道

注释

不恰当的信息

        注释只应该描述有关代码和设计的技术性信息

废弃的注释

        如果发现废弃的注释，最好尽快更新或删除，废弃的注释会远离它们曾经描述的代码，变成代码中无关和误导读者的浮岛。

冗余注释

        如果注释描述的是某种充分自我描述了的东西，那么注释就是多余的

糟糕的注释

        字斟句酌使用正确的语法和拼写，别闲扯，别画蛇添足，保持简洁

注释掉的代码

        删除它！别担心源代码控制系统还会记得它。

环境

构建系统应该是单步的小操作，不应该从源代码控制系统中一小点一小点的迁出代码。应该能够使用单个命令迁移出来，并使用单个命令构建

函数

避免过多的参数

        3个以上的参数非常值得质疑，应坚决避免。

输出参数

输出参数违反直觉，因为读者期望参数用于输入而非输出。如果函数非要修改什么东西的状态，就修改它所在对象的状态就好了。

标识参数

布尔值参数大声宣告函数做了不止一件事，令人迷惑应该删除。

死函数

永远不被调用的函数应该被删除。

一般性问题

一个源文件存在多种语言

        理想的源文件包括且只包括一种语言。现实可能会不得不使用多种，应该尽力缩小额外语言的数量和范围。

明显的行为未被实现

不正确的边界行为

        别依赖直觉理解代码，追索每一种边界条件，并编写测试

忽视安全

        关闭失败测试、告诉自己过后再处理具有非常大的安全隐患

重复

信息过多

        设计良好的模块有着非常小的接口，让你事半功倍。低劣的接口拥有大龄必须调用的函数，耦合度非常高。

死代码

垂直分隔

        变量和函数应该在就近被使用的地方定义。

函数名称应该表达其行为

学习算法

        不要无脑塞一大堆的if和for，让系统勉强工作。

遵循标准约定

        每个团队都应该遵循基于通用行业规范的一套编码标准。

函数只做一件事

在较高层级放置可配置数据

名称

采用描述性名称

名称应该与抽象层级相符

尽可能使用标准命名法

无歧义的命名

为较大作用范围选择较长的名称

避免编码