2016-09-05 3 views
3

Java 8で神聖なJavaDoc lint機能を無効にする方法に関する情報がたくさんあります。それを信じるかどうか、今日この機能を使用してJavaDocsを修正しました。しかし、その標準的な構成では、おそらくすべてが紛失していると不平を言っています。@param@returnJava 8 javadoc technotesのJavaDocのドキュメントにある私の選択肢は、-Xdoclint:all,-missingです。これにはすべての小切手が含まれていなければなりませんが、逃した文書の機会に苦情はありません。 mvn siteで実行している場合しかし、私はエラーを取得する合理的なdoclintパラメータを使ってmaven JavaDocを使用してください。

<reporting> 
    <plugins> 
     <plugin> 
     <groupId>org.apache.maven.plugins</groupId> 
     <artifactId>maven-javadoc-plugin</artifactId> 
     <version>2.10.4</version> 
     <configuration> 
      <additionalparam>-Xdoclint:all,-missing</additionalparam> 
      <aggregate>false</aggregate> 
     </configuration> 
     <reportSets> 
      <reportSet> 
      <id>default</id> 
      <reports> 
       <report>javadoc</report> 
      </reports> 
      </reportSet> 
     </reportSets> 
     </plugin> 
    </plugins> 
    </reporting> 

:Mavenの設定は次のようになり

[ERROR] Exit code: 1 - javadoc: error - invalid flag: -missing 

私は助けにはならなかった引用、しかし、Mavenの中のパラメータの処理が問題であると思われます。

これを使用する方法はありますか?妥当な方法でJavaDocをチェックするための代替の良いプラクティスはありますか?

+0

'-Xdoclint:" all、-missing "'かもしれませんが、1つは言及しました。 –

答えて

1

右の構文は次のとおりです。

-Xdoclint:all -Xdoclint:-missing 
+0

Mavenと協力してくれてありがとう! – cruftex

2

あなたは(-Xdoclint:all,-missing)を動作することを期待構文が正しいです。これは、ネイティブのコマンドラインjavadocツールでうまく動作します。残念ながら、カンマが使用されている場合、Maven JavaDoc Pluginは追加パラメータを複数のパラメータに分割しているようです。このバグはMJAVADOC-368に記載されています。

問題を回避するには、@ hasnae answer(-Xdoclint:all -Xdoclint:-missing)に記載されているより冗長な構文を使用してください。

関連する問題