メソッドやクラスなどを文書化するときに、いくつかのパラメーターや例外スロー (またはその他のもの) を誤って説明するのを忘れる場合があります。
欠落しているドキュメント項目について警告するように javadoc を実行することは可能ですか?
(ドキュメントの生成には ant スクリプトを使用します)
4 に答える
8
文書化されていない項目について警告を発する javadoc オプションを知りません。
ただし、たまたま Eclipse を使用している場合は、次の設定を確認してください。
ウィンドウ -> 設定 -> Java -> コンパイラ -> Javadoc
そこでは、文書化されていない項目に対して警告を発行するように Eclipse に指示できます。
于 2008-10-26T20:02:46.717 に答える
2
チェックスタイルを使おう！素晴らしい Ant 統合があり、ソース コードに対する他の何百もの重要なチェックもサポートしています。
ただし、必要になるのはJavadocType チェッカーです。
于 2008-10-27T10:39:57.630 に答える
2
以前のプロジェクトではDoc Check Docletを使用しました。これはビルドと統合でき、どのコードのドキュメントが貧弱であるかを示す有用なレポートを生成します。
注: このツールはベータ版であり、Sun ではサポートされていません。
于 2008-10-27T02:44:51.910 に答える
1
はい、そうです。Eclipse では、定義したものすべてにチェックが組み込まれているため、この欠落を「警告」に入れることができ、どこで間違いを犯したかを確認できます。
于 2008-10-26T20:04:37.897 に答える