4

我一直在使用用于 Python 的 SimPy 模块——它可以进行离散事件模拟。现在，代码已经变得相当大，并且有相当多的进程并行发生并相互交互。

在文档方面显示这一点的最佳方式是什么？类层次结构没有充分捕捉进程之间的交互，几乎所有的自动生成软件都停留在所有代码都有效地继承自 SimPy 模块这一事实上，因此为每个类生成了完整的 SimPy 文档：/

我想像 UML 这样的东西可能有用，但我对此不太了解。它需要捕获：

  • 流程
  • 活动
  • 队列（包括等待资源的进程...:)
  • 资源（例如可以填充/取消填充等并具有一定容量的数组）

所以基本上，任何简洁的模拟代码文档工具？

干杯

4

2 回答 2

2

UML 有状态图和活动图以及序列图。这些中的任何一个都是合适的。通常，需要组合图表。

每一类对象都有一个状态图。 http://en.wikipedia.org/wiki/State_diagram

活动图或序列图显示对象之间的特定交互或协作。 http://www.agilemodeling.com/artifacts/activityDiagram.htm http://www.ibm.com/developerworks/rational/library/3101.html

类图也适用于显示类的静态特征及其关系。 http://en.wikipedia.org/wiki/Class_diagram

“整个事情”通常很难记录。

于 2011-01-06T11:13:10.117 回答
0

使用图表和自写散文的组合。

恕我直言，您不需要使用 UML。如果非 UML 以更清晰/更简单的方式传输您的消息，请使用您喜欢的任何内容。

还要写一个包含所有基本概念的简短摘要，以便读者大致了解系统的意图是什么以及它的主要组件是什么。

然后写关于每个组件的更详细的文章并交叉引用其他文章。

Jacob Kaplan-Moss的文章系列Writing Great Documentation对我帮助很大。

于 2016-11-06T18:01:34.633 回答