注释禁用的JavaDoc [英] Annotation to disable JavaDocs

问题描述

有没有宣布一定的方法将不会被包含在，即使它是公共JavaDoc中的注解？

Is there an annotation to declare that a certain method will not be included in the JavaDocs even though it is public?

是这样的：

@nojavadocs
public void foo(){
//...
}

---

P.S。我在这里明白点左右API，但这些方法仅仅是不支持。他们的工作（而且必须是public从其他包接入），但我们不想打扰他们的记录，并回答有关如何时，他们的功能不相关的支持使用场景使用他们的问题。好的设计可能意味着其移动到另一个阶级，但它们在逻辑上是指数据在类。

P.S. I understand the point here about API, but the methods are simply "unsupported." They work (and must be public for access from other packages), but we do not want to bother documenting them and answering questions about how to use them when their functionality is not relevant to supported usage scenarios. Good design might mean moving them to another class, but they logically refer to the data in the class.

推荐答案

如果您正在使用Sun公司的JavaDocs工具。

Not if you're using Sun's JavaDocs tool.

他们有它功能请求，但它一直在低优先级自1997年以来。

They have a feature request for it, but it's been in low priority since 1997.

您可以编写自定义的doclet来解决这个问题，或者使用第三方工具（DocFlex或这样）。

You can write a custom doclet to overcome this, or use a 3rd-party tool (DocFlex or such).

这篇关于注释禁用的JavaDoc的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！