当前位置: 首页 > 工具软件 > Martin > 使用案例 >

代码整洁之道(RobertC.Martin)之第三章:函数

厍和颂
2023-12-01

一、前言

本章内容主要为函数 命名, 结构, 和职责规范。

二、函数规范

  1. 短小 => 函数尽可能短小 10行的函数和100行的函数
  2. 只做一件事 => 五大原则之单一原则
  3. 每个函数一个抽象层级 => 五大原则之lsp依赖倒置原则
  4. swtich语句 => 避免swtich语句使用吧 虽然我之前很喜欢用
  5. 使用描述性名称 => 不排斥函数长名称
  6. 函数参数少于三个 => 避免带来过多变化
  7. 一元函数 => 一个参数
  8. 二元函数 => 两个参数
  9. 标示参数 => 传入Boolean值 ,不确定变化 不符合职责单一原则。(根据我的理解, 这应该只限于开发简单模块时可以这样做, 当需要一个大型项目时, 这样做会带来无数的碎片文件。很简单的一个例子就是ui框架, 里面很多的属性可以布尔值控制)
  10. 三元函数 => 三个参数
  11. 参数对象 => 过多参数时使用参数对象
  12. 参数列表 => 列表参数
  13. 函数名 => 动词或关键字
  14. 无副作用 => 避免多种行为重置数据 (这个使用vue框架应该有体会, 一个方法使用不当, 就要挠破头去找在哪修改了这个数据)
  15. 分隔指令 => if(set(‘name’, ‘aaa’)) 分隔成 if(‘name’) set(‘aaa’) [个人觉得这个规范不太好]
  16. 抛异常代替返回码 => 提示比较好
  17. 错误处理就是一件事
  18. 分离try catch块
  19. 别重复自己 => 对于重复逻辑 考虑新建函数 实现逻辑复用
  20. 结构化编程 => 单入单出原则, 但是在本书中作者认为保持短小的函数形式, 用return或其它返回语句并无弊处。
  21. 最后, 无需一开始就按照规则, 可以根据自己的情况慢慢优化代码

三、总结

优秀的代码像是在写故事一样, 我推崇写代码就和写诗一样, 有自己的意境, 却也是别人看得懂的。

 类似资料: