Генерация HTML-документов для скомпилированных классов

Question

У меня есть java-библиотека, скомпилированная в jar.for, для которой я написал документацию в исходном коде. Есть еще один инструмент, который генерирует jar, он включает только те классы, которые требуются для целевого проекта. У меня есть огромные проекты используйте эту банку, и только те классы должны идти в целевой проект. Теперь проблема Я хочу дать документацию для классов. Можно ли генерировать документацию из скомпилированных классов?

Answer 1

Нет. Документация (javadoc) генерируется из исходных (.java) файлов. Все комментарии / javadocs теряются после компиляции.

Пользователи библиотеки смогут использовать автозаполнение своих IDE только в качестве некоторой документации.

Я не вижу ваш скрипт, но я предполагаю, что вы можете применить ту же логику к генерации javadoc, что и та, что генерирует jar.

Answer 2

Нет простого способа сделать то, что вы хотите, но вы можете попробовать следующий подход:

1. Извлеките имена всех .class файлов в вашем JAR-файле, отфильтровав все с $ в их имени и сопоставив остаток с исходными .java именами файлов.

2. Создать временное дерево каталогов, содержащее копии всех файлов .java, выбранных выше.

3. Запустите команду javadoc, используя дерево about в качестве источника.

Если у вас не слишком много файлов, вы можете пропустить шаг создания дерева каталогов и запустить команду javadoc со всеми именами файлов .java в качестве аргументов команды.

В любом случае у вас будет несколько нетривиальных сценариев ... или эквивалентной Java ... для реализации.

Answer 3

Полагаю, вам следует отфильтровать комментарии классов, требуемых для целевых проектов, отдельно и объединить с созданным вспомогательным флягой.