Документация по Java API - PullRequest
Новая
       34

Документация по Java API

3 голосов
/ 11 января 2012

Как я могу добавить документацию по Java в файл .JAR, чтобы, когда люди использовали мой файл JAR, введите «.»Eclipse отобразит документацию для доступных API (intellisense).

ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ

Я создал документ Java, но при экспорте файла JAR он не содержит intellisenseпри использовании в других проектах.Это то, с чем у меня возникают проблемы.

ОБНОВЛЕНИЕ Интеллектуальный смысл отображается только при экспорте источника.Однако я хочу скрыть исходный код.Как я могу обойти это?

Ответы [ 3 ]

3 голосов
/ 11 января 2012

Если вы не хотите включать весь исходный код в ваш .jar, вы можете сжать / сжать только javadocs (как бы вы их не создавали). Я делаю это с помощью опции меню Project-> Generate Javadoc в Eclipse).Затем конечный пользователь может «присоединить» их к указанной библиотеке в настройках пути сборки проекта.

Атрибутом местоположения javadoc библиотеки проекта может быть URL-адрес, локальный каталог или файл локального архива.

Заметив ваши изменения, я могу упомянуть, что у Ant есть задача javadoc , которая может генерировать ваши javadocs во время сборки.

2 голосов
/ 11 января 2012

У Maven есть очень элегантный способ справиться с этим.

Шаг 1: Maven способ генерирует javadocs: http://maven.apache.org/plugins/maven-javadoc-plugin/

Шаг 2: Чтобы Eclipse всегда прикреплял к этим документам, используйте maven-eclipse-plugin 

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-eclipse-plugin</artifactId>
    <configuration>
      <downloadJavadocs>true</downloadJavadocs>
    </configuration>
</plugin>

После того, как эти два шага будут выполнены, пользователи ваших jar-файлов API всегда будут иметь ваши последние версии Javadoc без дальнейшего вмешательства

0 голосов
/ 11 января 2012

В Eclipse экспортируйте проект с источниками.

Файл -> Экспорт ... -> Java -> Файл JAR -> Далее

Затем установите флажок Экспорт исходных файлов и ресурсов Java.

Затем продолжайте, пока JAR не будет создан.

Редактировать : после правок в вопросе этот ответ больше не действителен, но все еще полезен.

...