2011-01-27 10 views
2

クラスのパブリックメソッドのいくつかをjavadocsに含めないようにする必要があります。私はChris NoklebergのExcludeDoclet(sixlegs)を試しました。しかし、ドックレットはちょっとした問題を出しています: クラスの他のメソッドがList(または他のジェネリック)、つまり をListとしてjavadocに表示するのではなく、戻り値の型をリストとして表示しています)javadocクラスからいくつかのパブリックメソッドを除外

誰でもヒントを与えたり、この問題の解決方法を回避する方法はありますか?

+0

同様の質問:http://stackoverflow.com/questions/1120455/how-do-i-exclude-a-specific-method-constructor-from-the-results-of-the-javadoc-an/4815466# 4815466 –

+0

<! - リストがリストとして表示されています。 – Astha

+0

私は質問を再投稿しています。角括弧のために、一部の部分がタグとして解釈されました。 – Astha

答えて

6

javadocから除外するメソッドは、クライアントが使用したくないパブリックメソッドであると仮定します。つまり、これらのメソッドはdeprecatedです。必要なのは、@Deprecatedアノテーションを使用することです。このように:

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

ここで、badMethod()は推奨されていません。誰かがコード内でbadMethod()を使うと、彼はコンパイラから警告を受けるでしょう(彼は廃止予定のメソッドを使用しています)。

ただし、@Deprecatedアノテーションは、javadocから廃止予定のメソッドを除外しません。このメソッドをjavadocから除外するには、以下の操作を行います。javadocを生成するときは、nodeprecated javadoc cmd lineオプションを使用します。 -nodeprecatedオプションは、ドキュメンテーションに廃止​​予定のAPIが生成されないようにします。したがって、@Deprecatedアノテーションを使用し、-nodeprecatedオプションを指定してjavadocを生成すると、不正なメソッドはjavadocには表示されません。

私の意見では、非推奨のパブリックメソッドをjavadocから除外しないでください。ドキュメンテーションにそのメソッドが推奨されない理由と代わりに使用される理由の説明とともに表示される方が良いでしょう。

+2

+1を試しました。古いコードのユーザーは、使用すべき新しいメソッドを参照する必要があります。ほとんどのユーザーは怠惰なので、簡単にしないと、廃止予定のメソッドを残すことになります。 –

関連する問題