从现有的java代码创建设计文档
我有现有的java代码,需要基于它创建设计文档。
对于初学者来说,即使我可以获得带有输入/输出参数的所有函数,这将有助于整个过程。
注意:没有关于任何过程、函数或类的注释文档。
最后但并非最不重要的。让我知道任何可以减少此阶段所需时间的好工具。目前,我们编写每个流程和相关内容。
I have existing java code and need to create Design Document based on that.
For starter even if I could get all functions with input / output parameters that will help in overall proces.
Note: There is not commeted documentation on any procedures, function or classes.
Last but not least. Let me know for any good tool which will reduce time required for this phase. As currently we write every flow and related stuffs.
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
你想要的实在是太多了。引用 Linus Torvalds 的话:“好的代码本身就是最好的文档。”。无论如何,我离题了。
您可能想要研究从代码生成类/序列图的 UML 工具。它们有很多,但只有少数支持逆向工程(进入和来自类图),甚至更少的子集支持相同的序列图。我只知道MagicDraw可以做到这一点,但我有偏见,因为我曾经为这个工具的制造商工作,所以你先货比三家。
What you want is just too much. Quoting Linus Torvalds: “Good code is its own best documentation.”. Anyway, I digress.
You might want to look into UML tools which generate class/sequence diagrams from the code. There are many of them but only a handful support reverse engineering (into and from the class diagram), and even fewer subset support the same to/from sequence diagram. I only know MagicDraw could do this, but I am biased as I used to work for the manufacturer of this tool so do your shopping around first.
使用java文档: http://www.oracle.com/technetwork /java/javase/documentation/index-137868.html
或自省:http://docs.oracle.com/javase/tutorial/reflect/class/classMembers.html
Use java docs: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html
or Introspection: http://docs.oracle.com/javase/tutorial/reflect/class/classMembers.html