代码整洁之道

代码整洁之道-使用经验

结合实际项目经验及参考《代码整洁之道》

命名

  • 名副其实
  • 避免误导二义性,要以用户能鉴别的方式来区分
  • 使用可读可搜索名称
  • 避免使用编码
  • 类、方法、属性见名之意
  • 符合语境语义

函数

  • 短小,只做一件事
  • 使用具有描述性的名称
  • 避免使用三个以上的参数
  • 不要使用boolean 参数
  • 避免重复
  • 结构化编程

注释

  • 保持可维护、有关联、精确
  • 必要注释:法律信息
  • 避免废话、删除注释掉的代码

格式

  • 相关变量、相关函数、相关概念应放在一起
  • 注意缩进

对象和数据结构

  • 对象暴露行为 隐藏数据

错误处理

  • 使用异常而非返回码
  • 给出异常发生的环境说明
  • 不要传递、返回null

单元测试

  • 整洁的测试:具有可读性
  • 每个测试有一个断言
  • FIRST原则:Fast、Independent、Repeatable、Self-Validating、Timely

  • 小 封装 内聚

系统

  • 将系统的构造和使用分开
  • 依赖注入

你可能感兴趣的:(java)