Создание проектного документа из существующего кода Java

Question

У меня есть Java-код, и мне нужно создать документ проектирования на его основе.

Для начала, даже если бы я мог получить все функции с параметрами ввода / вывода, которые помогут в общем процессе.

Примечание: нет документации для каких-либо процедур, функций или классов.

Последнее, но не менее важное. Дайте мне знать о любом хорошем инструменте, который сократит время, необходимое для этого этапа. Как в настоящее время мы пишем каждый поток и связанные вещи.

Answer 1

Использовать документы Java: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

или самоанализ: http://docs.oracle.com/javase/tutorial/reflect/class/classMembers.html

Answer 2

То, что вы хотите, это слишком много. Цитируя Линуса Торвальдса: «Хороший код - лучшая документация для себя». Во всяком случае, я отвлекся.

Возможно, вы захотите взглянуть на инструменты UML, которые генерируют диаграммы классов / последовательностей из кода. Их много, но только горстка поддержки обратного инжиниринга (в диаграмму классов и из нее), и еще меньше подмножеств поддерживают такую ​​же диаграмму последовательности в / из. Я только знаю, что MagicDraw может это сделать, но я предвзят, поскольку раньше работал на производителя этого инструмента, поэтому сначала сделайте покупки.