在我的 Java 应用程序中，我总是注释我的类和方法以表明它们的全部内容。然而，我经常遇到的问题是记录一个完整的过程，该过程分布在几个类中。我需要记录所有部分是如何协同工作的，以便简单地概述某些东西是如何工作的。
我发现有问题的是我在哪里写这个文档。我也可以将它写在一个单独的文件中，例如 Word 文档，但文档往往会与实际代码疏远，并且可能会不同步。另一方面，如果我将它记录在单个 java 代码文件中，那么阅读其中一个依赖类的人很难知道该类如何适应整个过程，除非他们知道我所在的类中的文档写的。一种可能的解决方案是在构成整个过程的每个类中包含一个引用，并将其中一个类指定为文档来源的“主要”类。
还是有更好的替代方法来说明我应该如何做到这一点？
编辑：
例如，您有一个将数据上传到服务器的移动应用程序，然后您将数据从服务器下载到另一台设备。您有一个包含三个组件（发送移动设备、服务器和接收移动设备）的流程。这些都不能真正被认为是“整个数据传输过程的起点，所以在记录这个过程时，这个文档会去哪里？