如何從Javadoc中排除已棄用的公共方法？

Question

我想為我的類生成javadoc。 'generate Javadoc'命令為我提供了為具有可見性Private / Package / Protected / Public的成員創建Javadoc的選項。 但是有些公共方法我不想被包含在Javadoc中。 如何為此Javadoc生成器指定要包含哪些成員/方法以及哪些成員/方法不包含？

（我使用eclipse 3.4.2）

編輯：有些人問我想要這樣做的原因是什么。 原因是我有一些我不想存在的方法，但我仍然需要它們來實現向后兼容。 我將它們標記為@deprecated，以便嘗試使用它們的人會收到警告。 但我不希望它們出現在Javadoc中。 有沒有辦法將它們從javadoc中排除，因為它們被標記為@deprecated？

Answer 1

那么，為什么javadoc -nodeprecated不能解決問題呢？

Answer 2

你必須編寫自己的Doclet 。

Answer 3

所以你有一些必須公開的方法由於某種原因，但是類用戶不應該真的搞亂嗎？

您可以將這種JavaDoc用於那些“隱藏”的公共方法：

 /**
  * !!! THIS METHOD IS NOT PART OF PUBLIC INTERFACE !!!
  * !!! DO NOT USE !!!
  */
 public void somethingThatShouldNotBeUsedByOutsiders()

我快速瀏覽了一下，至少通過標准的JavaDoc工具似乎無法進行方法級排除。

Answer 4

正如Software Monkey所寫，你可能需要編寫自己的Doclet。 有一個例子幾乎可以做你想要的， ExcludeDoclet