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

Question

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

1

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

Tom 25 май 2009, в 21:19

Источник

Теги:

java

eclipse

javadoc

5 ответов

3

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

Zsolt Török 25 май 2009, в 17:46

1

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

Ben Hammond 25 май 2009, в 20:02

0

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

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

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

будет показывать foo (String text, Integer index), когда вы автоматически завершаете, а не foo (String arg1, Integer arg2), чтобы вы могли подсказать, какие параметры должен быть.

banjollity 26 май 2009, в 06:12

0

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

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

Seb 25 май 2009, в 17:05

0

Но Javadoc производит HTML, который я могу вручную указать на затмение в виде папки или банку. Я просто хочу иметь возможность включить это в мои распределенные фляги, чтобы затмение нашло это.
Tom 25 май 2009, в 18:46
0

Это верно, но вы не сможете поместить это в свой JAR. В любом случае, все решения, работающие так, как вы описываете, предоставляют zip-файл с внешним исходным кодом, который содержит как источники, так и javadoc. Если вы хотите, вы можете удалить источники методов и создать пустую оболочку, которая будет служить источником Javadoc.
Seb 25 май 2009, в 18:49

Ещё вопросы

Но Javadoc производит HTML, который я могу вручную указать на затмение в виде папки или банку. Я просто хочу иметь возможность включить это в мои распределенные фляги, чтобы затмение нашло это.
Это верно, но вы не сможете поместить это в свой JAR. В любом случае, все решения, работающие так, как вы описываете, предоставляют zip-файл с внешним исходным кодом, который содержит как источники, так и javadoc. Если вы хотите, вы можете удалить источники методов и создать пустую оболочку, которая будет служить источником Javadoc.

Jherico · Accepted Answer · 2009-05-25T21-28-00.000Z

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

Увы, мы используем муравья, а не мавена: o (
Вы можете использовать задачи сборки maven для генерации javadoc и / или исходных файлов jar, даже из Ant. Поскольку вы используете ant для построения и, предположительно, управления зависимостями, вам понадобится только минимальный pom для работы maven, указав исходный каталог, из которого нужно сгенерировать javadoc.
Это то, что я сделал в конце, ну вроде я строю банки src и doc с помощью ant, а не maven.