3

我想为我的课程生成 javadoc。“生成 Javadoc”命令为我提供了一个选项，可以为具有 Private/Package/Protected/Public 可见性的成员创建 Javadoc。但是有一些公共方法我不想包含在 Javadoc 中。如何为此 Javadoc 生成器准确指定要包含哪些成员/方法以及不包含哪些成员/方法？

（我使用eclipse 3.4.2）

编辑：你们中的一些人问我想这样做的原因是什么。原因是我有一些我不想存在的方法，但我仍然需要它们来实现向后兼容性。我将它们标记为@deprecated，以便尝试使用它们的人会收到警告。但我不希望它们出现在 Javadoc 中。鉴于它们被标记为@deprecated，有没有办法将它们从 javadoc 中排除？

4

4 回答 4

3

那么，为什么不javadoc -nodeprecated这样做呢？

于 2010-01-18T20:29:49.140 回答
1

您必须编写自己的Doclet。

于 2010-01-18T19:29:43.963 回答
0

正如 Software Monkey 所写，您可能必须编写自己的 Doclet。有一个示例几乎可以满足您的要求，即ExcludeDoclet

于 2010-01-18T20:09:37.443 回答
0

所以你有一些出于某种原因必须公开的方法，但是类用户不应该真正搞砸吗？

您可以将这种 JavaDoc 用于那些“隐藏”的公共方法：

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

我快速浏览了一下，似乎没有办法至少通过标准JavaDoc 工具进行方法级别的排除。

于 2010-01-18T19:29:57.390 回答