【转】代码整洁之道

代码整洁之道

December 10, 2010

Posted by anchuan under 心得体悟

199 Comments

代码永存

• 世上没有永动机，代码不会终结，也不会自动产生出来。
• 我们无法抛弃代码，因为她呈现了需求的细节，就是编程要做的事情

糟糕的代码可以毁掉一家公司

为什么会产生糟糕的代码？

• 理由多得很
  • 抱怨需求变化脱离了最初的设计
  • 哀叹进度太紧张，没有办法好好干活
  • 经理、SE、市场、客服的错。。。
• 自作自受
• 奋力护卫代码
  • 比如：你是一名医生，病人请求你在给他做手术之前别洗手，
    因为那会花太多时间，你会照办吗？

程序员要有“代码感”

• 能从混乱中看到变化与不变
  • 程序员就像是艺术家

什么是整洁代码？

• 代码逻辑应该直接了当，表达设计者的意图，让缺陷难以隐藏
• 依据某种分层战略完善错误处理代码
• 性能调至最优，省得引诱别人做没规矩的优化，搞出一堆混乱来
• 整洁代码只做好一件事件
• 单元测试和验收测试，便于其他人阅读和增补
• 用心雕琢的代码。几乎没有改进的余地。
  代码作者什么都想到了，如果你企图改进它，总会回到原点

有意义的命名

• 名副其实
• 避免误导
• 做有意义的区分
• 类名和对象名：名词或者名词短语
• 方法名：动词或动词短语

函数

• 短小
• 只做一件事
  • 函数应该做一件事。做好这件事。
  • 如果函数只是做了该函数名下同一抽象层上的步骤，则函数还是只做了一件事情
  • 只做一件事的函数无法被合理地切分为多个区段
• 每个函数一个抽象层级

军规

• 让营地比你来时更干净
• “你还得练，孩子，还得练”