Существует ли инструмент для генерации Javadoc, который автоматически генерирует ссылки @see на вызываемые методы?

Question

Я знаю, как создать простой javadoc для метода, но я подумал, что было бы очень полезно автоматически включить ссылки на методы, которые вызывает мой метод.Есть ли какой-нибудь инструмент, который будет сканировать код метода и автоматически помещать @see ссылки на вызываемые методы для меня в javadoc?Быстрый пример:

Если у меня есть метод A, который вызывает B, C и D, было бы здорово добавить Javadoc в Javadoc A, который указывает, что он вызывает B, C и D (вместе с @seeссылки на эти методы, чтобы вы могли прочитать Javadoc для них).

Что я действительно ищу, так это инструмент, который будет генерировать документацию потока процессов, где все, что я делаю, это документирую свой код, как я обычно делаю, запускаю этот инструмент, а затем я получаю документацию, которая скажет мнечто делает мой метод, и все другие методы, которые он вызывает (предпочтительно в порядке вызова методов).

Конечно, такой инструмент существует (возможно, их несколько), и я держу пари, что существует множество мнений о том, какой из них лучший.

Answer 1

Используйте "Doxygen".

Вы можете получить взаимосвязь функций даже без тега @see.

Не забудьте отредактировать файл conf, убедитесь, что у вас включен переключатель "function_call". (Извините, я не совсем уверен насчет названия коммутатора)

Answer 2

Я не думаю, что такой инструмент существует.Я надеюсь, что нет.Задача документации - прояснить ситуацию, и я думаю, что если к каждому вызову метода добавится @see, вы получите кучу спагетти.(Восхитительно, но вы ничего не хотите отсортировать.) Вы должны ограничить @see соответствующими или связанными методами.

Конечно, вы можете добавить код в javadoc, и может быть способом получения вызовов метода исходного кода для ссылки на Javadoc.Конечно, вы можете перейти к объявлению метода в Eclipse с опцией «Открытое объявление (F3)».