在Eclipse中用java代码记录流程

在我的java应用程序中，我总是对我的类和方法进行注释，以表明它们都是关于什么的。然而，我经常遇到的问题是记录一个完整的过程，其中的过程分布在几个类中。我需要记录所有部分是如何协同工作的，以便简单地概述某些东西是如何工作的

我发现有问题的是我在哪里写这个文档。我也可以把它写在一个单独的文件中，比如Word文档，但是文档往往与实际代码不一致，并且可能会失去同步。另一方面，如果我将它记录在一个java代码文件中，阅读其中一个依赖类的人就很难知道该类如何融入整个过程，除非他们知道我编写它的类中的文档。一个可能的解决方案是在构成整个流程的每个类中包含一个引用，并将其中一个类指定为文档来源的“主要”类

还是有更好的替代方法来指导我应该如何做

编辑：

---

例如，您有一个将数据上传到服务器的移动应用程序，然后将数据从服务器下载到另一个设备。您的流程包括三个组件（发送移动设备、服务器和接收移动设备）。所有这些都不能被认为是真正的问题“整个数据传输过程的起点，因此，当记录此过程时，此文档将转到何处？

您可以使用

@link

链接其他类吗？您可能可以使用javadoc进行此操作。package-info.java文件允许您在package视图中编写文档。我对类和方法使用javadoc，但这并没有提供任何解决方案来记录整个过程，这取决于您如何使用它。你可以把各种链接放在软件包页面上。你所指的“软件包页面”是什么？从没听说过。