Не удается запустить javadoc из консоли на java 10
Я пытаюсь получить javadocs для своих классов прямо из консоли с помощью следующего кода javadoc -sourcepath ./src/main java.packageName. Эти классы имеют зависимости от внешних библиотек (например, junit.framework). Этот код легко скомпилировать из IntelliJ IDEA или через mvn clean install, но когда я пытаюсь создать javadocs, я сталкиваюсь с проблемой, что внешние классы и пакеты не могут быть распознаны (например, error: package junit.framework does not exist). Та же проблема возникает и с JDK 8, но там все равно генерируются предупреждения и javadocs.
Использование плагина maven javadoc здесь, если вы решите пойти по этому пути вместо этого (как предлагает @Slaw): maven.apache.org/plugins/maven-javadoc-plugin/usage.html
Ответы 2
«Этот код легко скомпилировать из intellij», просто используйте функцию JavaDoc из intellij. Он должен работать
Инструменты — Генерация JavaDoc
Ну, это работает, но мне нужно знать, как это сделать прямо из консоли. Он будет запускаться из скриптов sh
Понятно, тогда я бы также предложил использовать maven, как написал @Slaw.
Есть два подхода, которые вы можете использовать, чтобы получить javadocs для сборки из командной строки:
Добавьте плагин maven-javadoc-plugin в файл POM вашего проекта, чтобы вы могли использовать (например)
mvn javadoc:javadocдля создания javadocs. Смотрите документацию плагина для более подробной информации.Запустите
javadocнапрямую с правильными аргументами командной строки.
Я подозреваю, что есть несколько причин, по которым ваша текущая попытка не удалась:
Похоже, вы создаете javadocs для своего дерева
src/test. Это может быть непреднамеренно.(Если приведенная выше «ошибка: ...» исходит из поколения
src/mainjavadoc, я озадачен, почему вашsrc/mainисходный код ссылается на пакетjunit.framework. Это могло бы сработать, но производственный код обычно не зависит от теста рамки.)Вам нужно использовать опцию
-classpath, чтобы указатьjavadoc, где найти внешние библиотеки.
Это было примерно -classpath. Кажется, нам нужно вручную передать все пути к классам
Почему бы не использовать Maven для создания Javadoc? maven.apache.org/plugins/maven-javadoc-plugin