知识卡片
全面是可理解性的敌人
UML 不适合生成整个系统的详图,细节文档应从代码生成,如 JavaDoc。附加文档只强调重要概念,用一杯咖啡能读完的散文配草稿图:包图展示逻辑块和依赖;每个包一张类图,只列帮助理解的重要特性,充当图形目录;再配少量最重要的交互图,复杂生命周期才画状态机图。发散:写文档时先问读者最需要哪几个点,其余交给代码。参见[[文档记录取舍]]。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
- · 开发过程
原书出处 · 1 处
- 开发过程 · 查看原书依据
应该做一些交互图来支持这张类图,用于展示系统中最重要的交互。再说一次,在这里选择性是重要的;记住,在这种文档中,全面是可理解性的敌人。
参考来源
- 位置:《UML精粹:标准对象建模语言简明指南》第2章《开发过程》2.6.3节(源文件:`_epub-src/EPUB/1.xhtml`)
- 结论依据:原文主张详细文档应从代码生成,附加文档只强调重要概念:包图看逻辑块与依赖,每包一张只含重要特性的类图,少量关键交互图,并指出全面是可理解性的敌人。
- 原始内容:应该做一些交互图来支持这张类图,用于展示系统中最重要的交互。再说一次,在这里选择性是重要的;记住,在这种文档中,全面是可理解性的敌人。