Mavenを使用する場合に、より厳密なJava 8 Javadocを回避する方法

Javadocに関しては、JDK8の方が（デフォルトで）より厳密であることをすぐに理解できます。（リンク -最後の箇条書きを参照）

Javadocを生成しない場合は、もちろん問題は発生しませんが、MavenリリースプロセスやCIビルドなどの問題が発生し、JDK7で正常に機能した場合に突然失敗します。Javadocツールの終了値をチェックするものはすべて失敗するようになりました。JDK8のJavadocはwarnings、JDK7 に比べておそらくもっと冗長ですが、ここでは範囲を広げません。私たちは話しているerrors！

この質問は、それについて何をすべきかについての提案を収集するために存在します。最善のアプローチは何ですか？これらのエラーはソースコードファイルで一度だけ修正する必要がありますか？巨大なコードベースがある場合、これは多くの作業になる可能性があります。他にどのようなオプションがありますか？

以前失敗したことのある、今失敗したことについてのコメントも歓迎します。

今失敗するもののホラーストーリー

wsimportツール

wsimportツールは、Webサービスコンシューマーを作成するためのコードジェネレーターです。JDKに含まれています。wsimportJDK8 のツールを使用しても、JDK8 のjavadocコンパイラでコンパイルできないソースコードが生成されます。

@authorタグ

私は3〜4年前のソースコードファイルを開いて、次のように表示します。

/**
 * My very best class
 * @author John <john.doe@mine.com> 
 */

これは、<文字のために失敗します。厳密に言えばこれは正当化されますが、それほど寛容ではありません。

HTMLテーブル

JavadocのHTMLテーブル？次の有効なHTMLを検討してください。

/**
 *
 * <table>
 *   <tr>
 *      <td>Col1</td><td>Col2</td><td>Col3</td>
 *   </tr>
 * </table>
 */

これはエラーメッセージで失敗しますno summary or caption for table。簡単な修正の1つは、次のようにすることです。

/**
 *
 * <table summary="">
 *   <tr>
 *      <td>Col1</td><td>Col2</td><td>Col3</td>
 *   </tr>
 * </table>
 */

しかし、なぜこれがJavadocツールからの世界一のエラーでなければならないのですか？

より明白な理由で失敗するもの

1. 無効なリンク、例えば {@link notexist}
2. 不正なHTML、例えば always returns <code>true<code> if ...

更新

リンク：

Stephen Colebourneによる主題に関する優れたブログ。

今のところ、Mavenを使用するときにJava 8のより厳密なJavadocを回避する最も簡単な方法は、Javadocを非アクティブにすることです。

-Xdoclint:noneこのパラメーターはJava 8にのみ存在するため、このパラメーターを定義すると、他のJavaのビルドが中断されます。これを防ぐために、Java 8でのみアクティブになるプロファイルを作成して、Javaのバージョンに関係なくソリューションが機能することを確認できます。

<profiles>
    <profile>
        <id>disable-java8-doclint</id>
        <activation>
            <jdk>[1.8,)</jdk>
        </activation>
        <properties>
            <additionalparam>-Xdoclint:none</additionalparam>
        </properties>
    </profile>
</profiles>

それをPOMに追加するだけでよいのです。

maven-javadoc-plugin 3.0.0ユーザーの場合：

交換する

<additionalparam>-Xdoclint:none</additionalparam>

沿って

<doclint>none</doclint>

@banterCZ、ありがとう！

Maven javadocプラグインを使用しているfailOnError場合は、オプションを使用して、htmlエラーが検出された場合にプラグインが停止しないようにすることができます。

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <configuration>
    <failOnError>false</failOnError>
  </configuration>
</plugin>

または、次のようにして完全なhtmlオプションを完全に無効にすることができます。

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
      <additionalparam>-Xdoclint:none</additionalparam>
    </configuration>
  </plugin>
</plugins>

詳細は情報。

maven-javadoc-pluginのバージョン3.0.0以降、doclintは専用のXMLタグを介して構成されます

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.0.0</version>
    <configuration>
       <doclint>none</doclint>
    </configuration>
</plugin>

私は@ThiagoPorciúnculaの解決策が好きですが、私にとっては十分には行きませんでした。

私は通常additionalparam、プロファイルによってオーバーライドされていないjavadocプラグインセットをすでに持っています。このため、私はしなければなりませんでした：

• 設定しdisableDoclint、デフォルトでは空にプロパティを。
• java> = 8の場合、disableDoclintプロパティを-Xdoclint:none
• 使用${disableDoclint} in theadditionalparam section of theのmaven-javadocによってPlugin`を。

これは冗長ですが、うまく機能するようです。

<properties>
    <!-- set empty property -->
    <disableDoclint></disableDoclint>
</properties>
<profiles>
    <profile>
        <id>disable-java8-doclint</id>
        <activation>
            <jdk>[1.8,)</jdk>
        </activation>
        <properties>
            <!-- set property if >= java 8 -->
            <disableDoclint>-Xdoclint:none</disableDoclint>
        </properties>
    </profile>
    ...
</profiles>

次に、下${disableDoclint}で、additionalparamすでに定義したセクションでオプションの変数を使用できます。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <executions>
        <execution>
            <goals>
                <goal>jar</goal>
            </goals>
            <configuration>
                <showPackage>false</showPackage>
                <additionalparam>-tag inheritDoc:X ${disableDoclint}</additionalparam>
            </configuration>
        </execution>
    </executions>
    <configuration>
        <showPackage>false</showPackage>
        <bottom>This documentation content is licensed...</bottom>
        <additionalparam>-tag inheritDoc:X ${disableDoclint}</additionalparam>
    </configuration>
</plugin>

これはJava 8で動作しますが、Java 7では構文エラーを引き起こしません。

エラーのno summary or caption for table場合、を使用して<table summary="">も機能しなくなることに注意してください。その場合は<caption>、次のように要素をテーブルに追加します。

<table>
    <caption>Examples</caption>
    ...
</table>

これが誰かを助けることを願っています。これがわかるまで、少し時間がかかりました。