从现有的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