代码之家 › 专栏 › 技术社区 › Alex

在应用程序中记录各种流程的好方法?[关闭]

documentation-generation documentation asp.net-mvc c#

1

Alex · 技术社区 · 16 年前

我想创建一个简单的中央文档,它直观地显示了我的ASP.NET MVC应用程序中的各种进程和依赖项,例如,当我的“注册”操作方法获得发布数据、解密和验证时,如何调用服务,最后,所有内容都使用存储库存储,电子邮件服务发送一个EMAI即使只是一个显示方法调用、实例名称和参数的流程图,从开始到结束(带有分支)都会非常好。

有没有什么东西可以自动完成(例如每个动作方法),或者你们是用手/使用特定的工具?它的关键是让新开发人员快速了解应用程序中存在哪些类型的依赖关系和流,而无需在源代码浏览中无休止地“转到定义”来了解事情的工作方式。

谢谢你

2 回复 | 直到 16 年前

1

JP Alioto 16 年前

我们使用 Altova UModel (我们所有的图表都是UML)。我喜欢它而不是Visio,但Visio是一个合理的选择。你说的是两种不同类型的图表, Activity Diagrams 和 Sequence Diagrams .同样有用的是 Data Flow Diagrams . 如果有一组正确的文档,让一个新的开发人员跟上速度就容易多了。当然,有时您必须首先让他们了解UML的速度(尽管阅读UML比编写适当的UML容易得多)。

从他们的页面(添加了强调)

视觉设计应用模型和生成Java, C,或vb.net代码和项目文档。 或者,逆向工程 UML 2图中的现有程序 然后微调你的设计完成往返行程正在重新生成代码。

2

0

Eric J. 16 年前

我个人使用 Enterprise Architect 对于这种类型的建模。它可以通过分析静态源代码信息和运行时行为自动建立某些关系。不过,我个人并不这么用……我首先对系统建模,然后基于该模型构建系统(通常需要从模型生成大量代码)。