呈现或可视化我的编程项目框架的最佳方式是什么

Question

我是土木工程专业的学生，我一直在使用以C#编写的Revit API为Autodesk Revit构建附加模块程序。我的Visual Studio项目被组织成我为我的程序创建的类。可视化和呈现/解释程序的整体框架/结构/体系结构的最佳/适当方式是什么？我想解释一下我的代码是如何构造的，以及它们的功能和类之间的交互。

提前感谢

Answer 1

您需要一个图表来显示系统的高级模块/组件。流行的绘图工具有Microsoft Visio、Modelio或draw.io。

UML是构建图表的一个很好的选择。使用序列图来描述对象/类之间基于时间的交互。

UML是一种繁重的建模语言，所以不用担心在图表中使用的每一种UML符号。与其说是为了清晰，不如说是更明确地适用于这里。

Visual Studio类设计器允许您创建软件https://docs.microsoft.com/en-us/visualstudio/ide/class-designer/how-to-add-class-diagrams-to-projects?view=vs-2019的类图

在Visual Studio Enterprise Edition中，如果您有权访问code maps，还可以添加它。