UML和记录长方法

时间:2011-07-08 20:46:01

标签: uml

我使用UML来记录旧c ++程序的部分内容。它只是代码的一部分,但记录它使我疯了,因为即使这个过程非常大。到目前为止,我已经在相关代码中使用了类图,并在必要时使用了一些活动和序列。

我的问题是我觉得到目前为止我所做的对整个文档有好处,但我想了解一些方法的脏细节,其中一个是202行,我应该用它做什么?活动图或序列?

我正在使用Visio来获取UML文档。

感谢。

3 个答案:

答案 0 :(得分:0)

经验法则可能是,如果看起来有多个代理人在彼此之间切换流,则使用序列;否则,活动。在单一功能中,活动可能是最好的 - 但不一定。

试着想象一下它最终会是什么样子,把自己置于无知的读者之中,并考虑哪个会更好地讲述故事。

将功能拆分为一个选项吗?

答案 1 :(得分:0)

问题是:您是否要描述那些少数方法正在执行的对象之间的过程或交互?该过程可以分解为执行的活动,它们的组成和数据流。交互由对象之间发送的消息组成。

答案 2 :(得分:0)

那么,

简短回答是:

如果要记录算法(由您的某个系统对象使用的方法):使用活动图。

长答案:

根据我的经验,UML文档是最糟糕的。

人们通常使用Uml工具自动将代码反向工程到Uml(通​​常是类图,有时是序列图),自动生成的图通常有许多细节,有时甚至是无意义的。

建议“正确评论您的代码”并使用 Doxygen 等工具。它们更适合代码文档。

但您可以将UML用于软件架构师文档。[SAD]。 Craig Larman在他关于 Documenting Architecture

的书中有很好的部分和例子
  

动机:为什么要创建SAD?   当有人加入开发团队时,如果项目教练可以说“欢迎使用NextGen项目,那么它很有用!请访问项目网站,阅读十页SAD,以便了解重要创意。”后来,在随后的发布中,当新人在系统上工作时,SAD可以成为一种学习辅助手段来加速他们的理解。

     

因此,应该写   这个观众和目标:什么   我需要说(并在UML中绘制)   这将很快帮助某人   了解这方面的主要观点   系统? [应用UML和模式第三版作者:Craig Larman] [第39章文档架构:UML& N + 1视图模型]

相关问题