Автоматическая проверка JavaDoc с Maven

Question

Во время рефакторинга часто случается, что JavaDoc устарел. Он описывает аргументы метода, которые больше отсутствуют или некоторые новые отсутствуют, чтобы привести примеры.

Было бы хорошо, если есть Maven-плагин, который автоматически проверяет существующий JavaDoc и останавливает сборку, если есть какие-то «нарушения JavaDoc». Я видел Maven-JavaDoc-Plugin и maven-doccheck, но оба, похоже, только могут исправить существующий JavaDoc автоматически в случае нарушений, вместо того, чтобы принести некоторую ошибку или предупреждение.

Кто-нибудь знает, как это сделать, если есть какой-то Maven-плагин и как его архивировать?

Answer 1

Насколько я знаю, в настоящее время это невозможно с помощью maven-javadoc-plugin. Для плагина JavaDoc есть javadoc:fix mojo, но это автоматически устраняет проблемы.

Недавно я создал запись JIRA для этой проблемы: MJAVADOC-374 (который acutally дубликат MJAVADOC-314).

Update: Вы можете использовать Checkstyle для проверки правильности JavaDoc. Параметры конфигурации: described here. Используйте maven-checkstyle-plugin и check-Mojo, чтобы интегрировать это в свою сборку maven.

пример конфигурации Maven может выглядеть следующим образом:

<project> 
    ... 
    <build> 
    <plugins> 
     <plugin> 
     <groupId>org.apache.maven.plugins</groupId> 
     <artifactId>maven-checkstyle-plugin</artifactId> 
     <version>2.15</version> 
     <configuration> 
      <logViolationsToConsole>true</logViolationsToConsole> 
      <checkstyleRules> 
      <module name="JavadocMethod"> 
       <property name="scope" value="public"/> 
       <property name="allowUndeclaredRTE" value="true"/> 
       <property name="allowMissingParamTags" value="false"/> 
      </module> 
      </checkstyleRules> 
     </configuration> 
     </plugin> 
    </plugins> 
    </build> 
    ... 
</project>