Отключение плагина Javadoc в Maven с помощью командной строки

Быстрый ответ

Для отключения плагина Maven Javadoc примените следующую команду:

mvn -Dmaven.javadoc.skip=true <фаза>

Замените <фаза> на соответствующую фазу жизненного цикла Maven, например, compile или install. Этот метод позволяет избегать генерации Javadoc при текущем выполнении.

Общий обзор пропуска генерации Javadoc

Пропуск генерации Javadoc становится особенно целесообразным в следующих случаях:

• Для ускорения процесса разработки;
• Для предотвращения ошибок сборки, вызванных проблемами с Javadoc;
• Для оперативного реализования срочных обновлений.

В частности, пропуск Javadoc полезно предусмотреть, когда:

• Имеются ветки разработки, не предназначенные для использования в производстве;
• Ведется работа с устаревшими проектами, для которых актуализация документации не предусматривается.

Визуализация

Можно считать, что отключение плагина Javadoc является своего рода переключателем:

Исходное положение: 🔌🌟 Плагин Javadoc – ВКЛ.

Производим переключение в командной строке с использованием опции -D:

mvn [задачи] -Dmaven.javadoc.skip=true

Результат: 🔌💤 Плагин Javadoc – ВЫКЛ.

Таким образом, одной командой вы отключаете генерацию документации, тем самым облегчая процедуру сборки!

Отключение плагина Javadoc: подробное руководство

Совместное использование с плагином Release

Если требуется пропустить генерацию Javadoc при работе с Release Plugin Maven, примените следующую команду:

mvn release:prepare release:perform -Darguments='-Dmaven.javadoc.skip=true'

Аргумент -Dmaven.javadoc.skip позволит пропустить создание Javadoc в процессе выпуска релиза.

Подробнее об этом расскажет наш спикер на видео

Выбор между настройкой проекта и командной строкой

Для установки свойства в pom.xml:

<properties>
  <maven.javadoc.skip>true</maven.javadoc.skip> <!-- Жизнь без Javadoc проста и беззаботна! 😎 -->
</properties>

При этом командная строка предлагает больше гибкости, позволяя избегать изменений в конфигурации проекта.

Генерация 'jar'-файла без Javadoc

Если потребуется сформировать JAR-файл без Javadoc:

mvn jar:jar -Dmaven.javadoc.skip=true <!-- Быстрая сборка 'jar', обходя Javadoc! 💣 -->

С помощью опции skip вы можете легко и несложно управлять процессом генерации документации.

Исключение необходимости в дополнительных профилях

При использовании -Dmaven.javadoc.skip=true отпадает необходимость настройки дополнительных профилей в pom.xml, что способствует поддержанию чистоты и оптимизации конфигурации вашего проекта.

Проблемы, с которыми вы можете столкнуться

Может возникнуть несколько проблем:

• Наследуемые настройки из родительских POM, требующие генерации Javadoc;
• Особенности работы с многомодульными проектами;
• Корректное обработка командных параметров при автоматизированных сборках.

Для решения этих вопросов явно укажите флаги в команде Maven или скорректируйте настройки сборочных процессов.

Полезные материалы

1. Командная строка Maven: опции — подробная информация о параметрах командной строки Maven.
2. Использование плагина Javadoc Maven — официальные рекомендации по использованию плагина.
3. Жизненный цикл сборки Maven — подробная информация о жизненном цикле сборки в Maven.
4. Профили сборки Maven — раздел о профилях Maven.
5. Часто задаваемые вопросы по Maven — страница с FAQ о Maven.