Как получить полный звонок Graph для целей документации?
-
16-09-2020 - |
Вопрос
Наша команда необходима для документирования каждого метода в нашем коде, и описывать то, что передается и выходит и такое.Можно ли автоматически генерировать документ, содержащий полное дерево иерархии вызова, начиная с функции и спускаться до всех возможных расширений вызовов?Как?Использование Eclipse, пружина, гибернация.Также у нас есть доступ к NetBeans, и все остальное, что поможет.
Я знаю, что это совершенно ненужно, но иногда мы находимся в этих ситуациях и не можем сделать много об этом: -).
в основном мне нужен генератор графа Java Call, я думаю, причина, по которой я не могу найти, это потому, что виртуальные функции предотвращают статический анализ?
Решение
Я настоятельно рекомендую doxygen .
Даже с «не обработанным» кодом, он будет генерировать вызовы деревьев, диаграммы наследования класса и более как HTML.Если вы добавите несколько специально отформатированных комментариев (по одному классу, функциям, приметной структуре данных), вы можете получить больше из него .
Проверьте Примеры и огромный
Я лично не использовал бы ничего другого и настаивать на том, чтобы весь код, написанный в моей компании, использует doxygen.
Редактировать: p.s doxygenis настолько полезны, даже на незаконном коде, что это первый инструмент, который я ищу, когда я нануждаю чужой наследный код.Ничто другое не дает мне такой хороший обзор так быстро.
Другие советы
Это не точное решение вашей проблемы, купить вы можете использовать Doclet API и написать свой собственный Doclet.Вы можете получить доступ к методам со своими аргументами и их возвратными типами и гораздо больше.Когда вы идете таким образом, вы также можете захватить комментарии метода для целей документации.