转载

有洁癖的代码

预计阅读时间: 3 分钟

代码整洁艺术:

  1. 代码的编码需要很多小技巧
  2. “代码感”帮助程序员选出最好的方案,并制定修改的行动计划
  3. 编写整洁代码的程序员就是艺术家,能让一块白板变作由优雅的代码构成的系统

技巧学习:

  1. 有意义的命名
  2. 函数
  3. 注释
  4. 格式
  5. 错误处理
  6. 边界
  7. 单元测试
  8. 重构改进

命名

  1. 废话就是冗余:NameString会比Name好吗?难道Name会是一个浮点数不成?
  2. 使用能读出来的名称:genymdhms(生成日期,年、月、日、时、分、秒)这种就很糟糕了,只能一个个字母来读;generationTimestamp(生成时间戳)是不是很好读了
  3. 添加有意义的语境,例如:firstName,LastName,street,city,state等,如果只是看到这个很难想象这是定义地址的变量,可以适当加点前缀:addrFirstName,addrLastName等

函数

  1. 函数第一规则是短小
  2. 只做一件事情
  3. 使用描述性名称,函数名称从testableHtml改为SetupTeardownIncluder.render,私有方法名称可以用isTestable或includeSetupAndTeardownPages。
  4. 动词与关键字,对于一元函数,函数和参数应该形成一对动词/名词形式比较好;例如write(String name),更好点writeField(String name),他告诉我们,name是个field。

注释

  1. 用代码阐述:用if((flag&&HOURLY_FLAG)&&(age>25))还是用if(isEligibleForFullBenefits())更好呢,我选择后者
  2. 提供信息注释:对函数的功能进行描述,例如://Returns an instance of the Responder being tested
  3. 去掉已经注释掉的代码:很多时候我们不用这段代码了,只是注释一下放在哪,很不美观,现在有svn,git这么多文件管理工具还怕不能找回之前的代码?

更新待续。。。

原文  http://boke.iflsy.com/archives/1409
正文到此结束
Loading...