从现有的java代码创建设计文档

Question

我有现有的java代码，并需要创建设计文档的基础上。

对于初学者来说，即使我可以获得所有函数和输入/输出参数，这将有助于整体处理。

注意:没有关于任何过程、函数或类的备注文档。

最后但并非最不重要。让我知道任何好的工具，将减少这一阶段所需的时间。目前，我们编写每一个流程和相关的东西。

Answer 1

你想要的太多了。引用Linus Torvalds的话：“好的代码本身就是最好的文档。”不管怎样，我离题了。

您可能希望研究从代码生成类/序列图的UML工具。它们有很多，但只有一小部分支持反向工程(进入和来自类图)，甚至更少的子集支持相同的序列图。我只知道MagicDraw可以做到这一点，但我是有偏见的，因为我曾经为这个工具的制造商工作，所以先去选购吧。

Answer 2

使用java文档：http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

或者是自省：http://docs.oracle.com/javase/tutorial/reflect/class/classMembers.html