Clean Code

• make the camp cleaner than when you arrived.

一、整洁代码

• 整洁的代码只做好一件事；
• 能通过所有测试；没有重复代码；体现系统中所有的设计理念；包括尽量少的实体，如类，方法，函数等；

二、命名

• 类名和对象名应该是名词或名词短语；方法名应当是动词或动词短语；

三、函数

• 自顶向下读代码——向下规则；
• 一个函数只停留于一个抽象层级；
• switch语句；多态；派生；

函数名称：

• 使用描述性名称；别还怕长名称；别还怕花时间取名字；命名方式保持一致；
• “如果每个例程都让你感到深合己意，那就是整洁的代码”

函数参数：

• 最理想的参数数量是零（零参数函数），其次是一，再次是二，应尽量避免三参数；
• 重复可能是软件中一切邪恶的根源；

四、注释

• 注释不能美化糟糕的代码；
• 尽可能修改代码，使代码能够明了的阐述表达而不需要注释；

好注释：

• 法律信息；
• 提供信息的注释；
• 对意图的解释；
• 阐释；
• 警示；
• TODO注释；
• 放大；
• 公共API中的JavaDoc

坏注释：

• 喃喃自语；
• 多余的注释；
• 误导性的注释；
• 循规式的注释；
• 日志式的注释；
• 废话；
• 为指标记；
• 括号后面的注释；
• 归属于署名；
• 注释掉的代码；
• HTML注释；
• 非本地信息；
• 信息过多；
• 不明显联系；
• 函数头；
• 非公共代码中的Javadoc；
• 范例；

CleanCode 中文版PDF

loading…ding….