Javadocs Исчезают - PullRequest
Новая
       14

Javadocs Исчезают

0 голосов
/ 24 декабря 2011

Я только что создал утилиту JAR среднего размера для использования во многих других проектах Eclipse.Я потратил много времени на написание утомительных javadoc, так что было бы совершенно очевидно, как использовать API.

Я использовал Ant, чтобы выбросить все в JAR, и теперь я добавляю этот JAR в путь сборкинового проекта.Но низко и вот ... когда я наведите курсор мыши на любой из моих служебных классов / методов, всплывающая подсказка говорит:

Примечание: этот элемент не имеет ни прикрепленного источника, ни присоединенного Javadoc и, следовательно, никакого Javadocможно найти.

Что здесь происходит?Какое решение?Вот цель dist Ant, которая JAR-файл моего проекта утилит: 

<target name="dist" depends="compile">
    <jar jarfile="dist/testing-utils.jar">
        <fileset dir="bin/main" />
        <fileset dir="src/main/config" />
    </jar>
</target>

Что еще мне нужно настроить?!?Заранее спасибо!

Ответы [ 2 ]

3 голосов
/ 24 декабря 2011

Задача компиляции Java, которую, как я полагаю, вы используете в цели "compile", генерирует байт-код из вашего исходного кода Java. Этот байт-код не будет включать комментарии по дизайну, и, следовательно, ваш дистрибутив не будет содержать комментарии.

То, что вы, вероятно, ищете, это присоединить источник в Eclipse, чтобы получить доступ к Javadocs. Вы можете прикрепить источник к банкам библиотеки, щелкнув правой кнопкой мыши по целевому банку, выбрав свойства, выбрав «Вложение исходного кода Java» и указав местоположение исходного банку. Вы также можете указать местоположение папки, если хотите сослаться на ваш проект напрямую.

Чтобы сгенерировать Jar-файл, содержащий javadocs и источник, вы можете использовать в муравье следующее: 

<target description="bundle sources in a jar" name="package-sources">
    <jar basedir="src" destfile="build/release/${ant.project.name}-${project.version}-sources.jar"/>
</target>

Ссылка

0 голосов
/ 24 декабря 2011

Если вы хотите отправить источники, ответ Джонарла, вероятно, правильный; это первый из двух вариантов, предлагаемых подключенными к затмению источниками. Если вы не хотите отправлять источники, вам нужно сгенерировать javadocs, см. Задачу ant javadoc . При таком подходе у вас будет два jar-файла: один содержит скомпилированные классы, а другой - документацию. В eclipse ваши пользователи добавят jar класса в проект, а затем присоединят к нему javadoc jar.

...