我必须将类的一些公共方法排除在 javadoc 之外。我尝试了 Chris Nokleberg 的 ExcludeDoclet (sixlegs)。但 doclet 给出了一个小问题：
如果类中的其他方法返回 List （或任何其他泛型），
返回类型不是在 javadoc 中显示为列表，而是仅显示为列表（没有通用信息）
任何人都可以给出提示或提供解决此问题的方法吗？
我假设您想要从 javadoc 中排除的方法是您不希望客户端使用的公共方法。换句话说，这些方法是已弃用 http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html。您需要做的是使用 @Deprecated 注释。像这样：
@Deprecated public void badMethod() {
...
}
现在，badMethod() 已被弃用。如果有人在代码中使用 badMethod()，他会收到编译器的警告（他正在使用已弃用的方法）。
但是，@Deprecated 注释并不从 javadoc 中排除已弃用的方法。为了从 javadoc 中排除该方法，您需要执行以下操作： 生成 javadoc 时，使用节点推荐的 http://download.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#nodeprecatedjavadoc 命令行选项。 -nodeprecated 选项可防止生成文档中任何已弃用的 API。因此，如果您使用 @Deprecated 注释并使用 -nodeprecated 选项生成 javadoc，那么您的错误方法将不会出现在 javadoc 中。
但在我看来，您不应该从 javadoc 中排除已弃用的公共方法。如果它们出现在文档中，并解释为什么不推荐使用该方法以及使用什么方法，那就更好了。
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
