Как заставить Eclipse показывать Javadoc из моих классов, не включая источники в банку

Question

Я создаю jar-файлы, где хочу упаковать их без исходников, но я бы хотел, чтобы javadoc появился для разработчиков в eclipse.

Answer 1

Пользователи вашего JAR могут связать местоположение Javadoc (URL, файл или путь в архиве) с ним в свойствах пути компоновки Java проекта Java, где используется JAR.
Я не уверен, насколько хорошо это будет работать с Javadoc в том же JAR-файле, что и двоичные файлы (никогда раньше не видел), но теоретически это должно работать.

Answer 2

Каков ваш процесс сборки? Процесс выпуска Maven фактически генерирует 3 файла jar, один из которых содержит скомпилированные классы, один с исходными кодами, а другой с javadocs. Вы должны иметь возможность настроить POM для предотвращения распространения исходного jar-файла, и любой, кто использует Maven для управления зависимостями, автоматически получит javadoc, если объявит зависимость от вашего jar (и включит загрузку javadoc в плагине eclipse maven).

Answer 3

Задача Apache Ant javadoc создаст API html. Обычно вы затем распространяете это в виде zip-файла вместе со своими банками.

Answer 4

У JIDE есть инструмент (стоит $ 25), который будет перебирать ваш исходный код и удалять все тела методов, оставляя в нем javadoc, и создавать zip-файл. Затем вы можете распространять этот zip как исходный zip, и ваша IDE сможет читать javadocs, но, конечно, вся ваша логика была удалена, чтобы вы могли сохранить свою закрытую исходность. Любые закрытые члены и методы не включены в zip-файл.

Он также имеет дополнительный бонус за сохранение имен параметров метода для intellisense, поэтому следующий метод

public void foo( String text, Integer index ) {
}

покажет foo (текст строки, целочисленный индекс) при автозаполнении вместо foo (строка arg1, целое число arg2) , поэтому вы можете подсказать, какими должны быть параметры .

Answer 5

Javadocs являются частью исходного кода, так как любой скомпилированный класс не будет содержать никаких комментариев - Javadocs являются комментариями.

Другими словами, вы не можете.