Как получить полный график вызовов для целей документации?

Question

От нашей команды требуется документировать каждый метод в нашем коде, а также описывать, что передается, и так далее.Можно ли автоматически сгенерировать документ, содержащий полное дерево иерархии вызовов, начиная с функции и опускаясь до всех возможных расширений вызовов?Как?Использование затмения, весны, спячки.Также у нас есть доступ к NetBeans и ко всему прочему, что могло бы помочь.

Я знаю, что это совершенно не нужно, но иногда мы оказываемся в таких ситуациях и ничего не можем с этим поделать: -).

В основном мне нужен генератор графа вызовов Java, я думаю, что причина, по которой я не могу его найти, заключается в том, что виртуальные функции предотвращают статический анализ?

Answer 1

Я настоятельно рекомендую Doxygen .

Даже с «необработанным» кодом он будет генерировать деревья вызовов, диаграммы наследования классов и многое другое в виде HTML.Если вы добавите несколько специально отформатированных комментариев (по одному на класс, функцию, заметную структуру данных), вы сможете получить на много больше.

Ознакомьтесь с примерами и огромным списком проектов, в которых используется doxygen .

Лично я бы не стал использовать ничего другого и настаивал на том, чтобы весь коднаписанный в моей компании использует doxygen.

Редактировать: ps doxygenis настолько полезен, даже для некомментированного кода, что это первый инструмент, который я ищу, когда наследую чей-то унаследованный код.Ничто иное не дает мне такой хороший обзор так быстро.

Answer 2

Это не точное решение вашей проблемы, но вы можете использовать Doclet API и написать свой собственный Doclet. Вы можете получить доступ к методам с их аргументами, типами возвращаемых данных и многим другим. Когда вы идете по этому пути, вы также можете получить комментарии метода для целей документирования.