知识卡片
能用代码表达就不画图
何时画顺序图、画多少,书中给出三层判断:
- 先问是否真的必要。代码通常更易交流也更经济:一段 Payroll.DoPayroll 代码遍历员工列表、判断是否发薪日、计算工资和扣款并发送支付,本身就无需解释,此时顺序图是冗余的。团队应以写出能自我表述的代码为目标,代码越能自我表述,越不需要图。
- 若必要,拆成小场景。不要画满是对象和消息、没人看懂也没人愿意看的大图;每张图控制在一页之内并留出说明文字的空间,不要为了塞进一页而缩小图标。也不要画成百上千张,找出各场景的共同部分重点表达,共同点比差异更重要。
- 想清楚要表达的层次。展示计算小时工资这类低层操作细节,不如展示系统全局流程的高层视图有用,高层图帮助读者联想整个系统、揭示共性。
总结:在白板上偶尔画画,或在一张小纸上用五六张图记录子系统最常见的交互,都很有价值;上千张顺序图的文档价值可能还不如纸。“写代码前先画出每个方法的顺序图”是 20 世纪 90 年代最大的软件开发谬误之一。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
- · 第18章 顺序图
原书出处 · 1 处
- 第18章 顺序图 · 查看原书依据
真的能用代码来描述系统的某个部分吗?事实上,这应该成为开发人员和设计师的一个目标。团队应该致力于创建出具有表达力、易读的代码。代码越是能够自己表述,你就越不需要图示,整个项目就会越好。
参考来源
- 位置:《敏捷开发(纪念版)》第18章《第18章 顺序图》时机和场合;小结(源文件:extracted/敏捷开发(纪念版)/_epub-src/Min Jie Kai Fa (Ji Nian Ban )_split_028.html,来源项目 book-sources)
- 结论依据:原文以 Payroll 代码说明能自我表述的代码无需顺序图,建议拆分大图为小场景、每图一页、聚焦共性、优先高层视图;小结批评先画所有方法顺序图的做法。
- 原始内容:真的能用代码来描述系统的某个部分吗?事实上,这应该成为开发人员和设计师的一个目标。团队应该致力于创建出具有表达力、易读的代码。代码越是能够自己表述,你就越不需要图示,整个项目就会越好。