Как распространять Javadoc для библиотеки?

Я пишу пользовательскую библиотеку. Он встроен в архив.jar. Я полностью в состоянии генерировать Javadoc, но я не знаю, как мне его распространять?

  1. Поместите это в тот же.jar с библиотекой
  2. Поместите это в другой.jar
  3. Как-то иначе?

И как включить Javadoc в другой проект, который использует мою библиотеку?

  1. Если бы я поместил его в тот же.jar, я должен был написать что-то в манифесте?
  2. Если он находится в отдельном.jar, достаточно ли включить его в проект?

Я использую NetBeans 9.1.

Источник

3 ответа

Решение

Я бы включил библиотеку.jar, документацию и другие вещи, такие как README, файл лицензии и т. Д. В один архив (zip или tar.gz).

mylib-1.0.1.tar.gz, который содержит:

mylib-1.0.1/
           ├── javadoc
           │   └── index.html  (and all other javadoc files under here)
           ├── mylib-1.0.1.jar
           └── README

Вместо расширенного каталога javadoc/ sub в архиве вы можете добавить сжатый javadoc в mylib-1.0.1-javadoc.jar (или zip), оба варианта являются общими.

mylib-1.0.1/
           ├── mylib-1.0.1-javadoc.jar
           ├── mylib-1.0.1.jar
           └── README
Источник

Общая практика - хранить JavaDocs в отдельном архиве. или даже чаще, в каталоге под названием "документы". вам не нужно раздувать архив вашей библиотеки файлами html и js.

И почему вы хотите включить сгенерированные JavaDocs [html + js] в ваш проект? Пока исходный код комментариев JavaDoc находится на месте, кто-то, использующий вашу библиотеку, сможет увидеть их, просто наведя курсор мыши на любую из современных IDE.

Обновить
Согласно комментарию Нанды ниже, я проверил то же самое, и он прав. В моем проекте я фактически прикрепил Javadoc из папки 'doc' к архиву, чтобы иметь возможность просматривать их при наведении курсора мыши.

Источник

Другой способ: для меня это был лучший выбор: (добавление в build.xml. Я тестировал его в IDE NetBeans 7.0 и 7.2.1) (нашел его в разделе Автоматическое создание jar-файлов исходного кода и документов в Netbeans)

<target name="-post-jar" description="bundle sources and javadoc in a jar" depends="javadoc">
<jar compress="${jar.compress}" basedir="${src.dir}" jarfile="${dist.dir}/${application.title}-sources.jar"/>
<jar compress="${jar.compress}" basedir="${test.src.dir}" jarfile="${dist.dir}/${application.title}-test.jar"/>
<jar compress="${jar.compress}" basedir="${dist.javadoc.dir}" jarfile="${dist.dir}/${application.title}-javadoc.jar"/>

Это создаст четыре файла jar: один для прикладной программы, один для исходных текстов, один для тестов и один для javadoc.

Источник
Другие вопросы по тегам