美团点评技术俱乐部线上微课001期《编写优雅的代码》PPT

1. 刘欢@技术工程部 2016045

2. JavaScript Ruby
PHP
HTML5
Python
Who we are
Scala

3. 怎样的代码是优雅的？
功能正确 健壮 易维护
简单明了 美观
……

4. • 正确的完成
• 统一与规范
• DRY KISS YAGNI

5. Done is be=er than perfect
• 逻辑正确
a. 输入输出
b. 边界正确
c. 异常正确
• 业务正确
a. 小需求重复确认
b. 较大项目需求评审
• 可重复验证
a. 单元测试：覆盖量
b. 集成测试：充足的测试用例
• 项目管理
a. 按时交付：时间管理 -> 分解任务
b. 保质交付：风险管理 -> 尽早暴露问题

7. Keep clear

8. Keep clear

9. Keep clear

10. Keep clear
满足要求的前提下，保持逻辑清晰易读！

11. • 正确的完成
• 统一与规范
• DRY KISS YAGNI

12. 风格

13. 统一风格
在风格上与大家统一，在代码真正的逻辑实现上挥洒个性

14. “大括号”问题多

15. 代码规范的作用
• 提高合作效率
• 长期的规范可以养成良好的编码习惯
• 更加严谨的思维能力

16. 命名

17. 命名

18. 命名
• 风格统一
• 包命名：namespace
• 类命名：是一类什么
• 方法命名：干什么
• 变量命名：是一个什么
• 资源文件命名：什么用途、如何生成、有效期
• 一些约定： 参照下面google的java开发规范文档

19. google-java-style
中文翻译出处：h=p://www.hawstein.com/posts/google-java-style.html
原版出处：h=ps://google.github.io/styleguide/javaguide.html

20. 搞定了命名？开始写码！
• 变量：
a. 避免magic number：http://coolshell.cn/articles/4576.html
b. 最小作用域：括号、局部、对象成员、类成员、常量
• 方法：
a. 最小可见性
b. 主方法描述逻辑层次，调用方法描述实现
c. 短小简单：方法命名中有 and、or、if … x
d. 参数少：过多的参数需要抽象成类
e. public方法要检验入参
• 类：
a. 面向对象
b. 类成员的最小可见性：private、protected、public
c. 设计原则：SOLID

21. 变量作用域

22. 变量作用域

23. 变量作用域

24. May the log with you
• 日志的作用：记录现场（过程、状态、数据）
• 必要性：回溯
• 分等级：
a. debug：过程
b. info：状态
c. warn：允许的错误
d. error：必须关注的错误
• 无需解释（高性能要求的环境下例外）

25. log

26. “注释”的trick
不要在标新立异的地方写注释！

27. “注释”的trick

28. “注释”的trick
尽量不要在代码块中写多个多行注释！

29. Talk is cheap
show me the code

30. 注释
• 统一风格
• 不依赖于注释：无需解释
• 解释为什么
• 说明复杂的步骤

31. 注释不写什么
• 变量说明
• 删除的代码
• 跟代码无关的注释
• 业务说明注释 -> 文档（API）
• todo -> 开发文档

32. • 正确的完成
• 统一与规范
• DRY KISS YAGNI

33. DRY = Don’t Repeat Yourself
• 容忍重复、拒绝重复
• 没有重复逻辑的代码更易于维护和bug修复
• 方法、代码块 功能明确
• 不要提前抽象

34. KISS = Keep It Sample and Stupid
• 尽量简单，一目了然
• 简单的逻辑bug少
• 简单的代码易维护

35. YAGNI = You Aren’t Gonna Need It
• 专注核心模块
• 满足可以看得到的情况
• 不要过度设计

36. 重构
• 真的需要吗？
• 代码真的都懂了吗？
• 业务细节也都清楚吗？
• 给出详细计划文档，相关熟悉的人都来评审
• 做好心理准备：跑得越久的代码，重构是个长
期的体力脑力活儿。
• 还是确定要重构？
• 上吧！

37. 推荐阅读
• h=ps://google.github.io/styleguide/
javaguide.html
• 《代码整洁之道》
• 《重构》
• 《程序员修炼之道》

38. 谢谢