3

クラスのいくつかのパブリック メソッドを javadoc に含めないようにする必要があります。Chris Nokleberg の ExcludeDoclet (sixlegs) を試しました。しかし、ドックレットにはわずかな問題があります。クラス内の他のメソッドが List (またはその他のジェネリック) を返す場合、javadoc で List として表示されるのではなく、戻り値の型が List として表示されるだけです (ジェネリック情報なし)。

この問題を解決する方法について、ヒントや回避策を提供できる人はいますか?

4

1 に答える 1

7

javadoc から除外したいメソッドは、クライアントに使用させたくない public メソッドだと思います。つまり、これらのメソッドは非推奨です。あなたがする必要があるのは、 @Deprecated アノテーションを使用することです。このような：

@Deprecated public void badMethod() {
    ...
}

現在、badMethod() は非推奨です。誰かが自分のコードで badMethod() を使用すると、コンパイラから警告が表示されます (非推奨のメソッドを使用しているということです)。

ただし、@Deprecated アノテーションは、非推奨のメソッドを javadoc から除外しません。メソッドを javadoc から除外するには、次のことを行う必要があります。 javadoc を生成するときは、nodeprecated javadoc コマンド ライン オプションを使用します。-nodeprecated オプションは、ドキュメント内の非推奨 API の生成を防ぎます。したがって、@Deprecated アノテーションを使用し、-nodeprecated オプションを指定して javadoc を生成すると、不適切なメソッドが javadoc に表示されなくなります。

しかし、私の意見では、非推奨の public メソッドを javadoc から除外すべきではありません。メソッドが非推奨である理由と代わりに何を使用するかについての説明とともにドキュメントに表示されるとよいでしょう。

于 2011-01-27T12:39:21.723 に答える