繁体   English   中英

如何从Javadoc中排除已弃用的公共方法?

[英]How to exclude deprecated public methods from Javadoc?

我想为我的类生成javadoc。 'generate Javadoc'命令为我提供了为具有可见性Private / Package / Protected / Public的成员创建Javadoc的选项。 但是有些公共方法我不想被包含在Javadoc中。 如何为此Javadoc生成器指定要包含哪些成员/方法以及哪些成员/方法不包含?

(我使用eclipse 3.4.2)

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

那么,为什么javadoc -nodeprecated不能解决问题呢?

你必须编写自己的Doclet

所以你有一些必须公开的方法由于某种原因,但是类用户不应该真的搞乱吗?

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

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

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

正如Software Monkey所写,你可能需要编写自己的Doclet。 有一个例子几乎可以做你想要的, ExcludeDoclet

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM