我肯定有一个相当普遍的文档需求......
我正在实现一个相当大的 Java 库代码库，除其他外，它包含各种类，这些类旨在在适当的抽象级别上公开给调用者/实现者。同时，代码库当然包含库的用户在使用 API 时不需要了解的各种内部类、接口(interface)和其他抽象。
许多其他 API 库都犯了一个错误，即简单地将所有内容都扔进 Javadocs，并让用户通过猜测组合来确定他们作为调用者实际需要处理哪些对象和实体，推理，如果幸运的话，还有示例代码。
我不想处于同样的位置。我想要一组“内部”Javadocs 来公开代码库的整个范围，以及一组“外部”Javadocs 旨在向开发人员清楚地传达他们实际需要使用的类的特征来获得他们的完工。我不需要也不想用他们不需要看到或知道的各种内部抽象来混淆水域——他们不需要知道这一切在引擎盖下是如何工作的，这只会让他们感到困惑和误导，导致 API 学习过程效率非常低下。
我怎样才能做到这一点？是否存在众所周知的“javadoc”参数组合以及一些可以实现此目的的注释？
非常感谢您的考虑!
最佳答案
假设您已遵循最佳实践并将内部类放在与公共(public) API 不同的包中，您可以运行 javadoc 并将公共(public) API 包名称作为命令行参数。
引用javadoc command line synopsis了解更多详情。
(如果您没有组织您的包以将内部类排除在 API 包之外，您可能会感到有点痛苦......)
关于java - 选择性 API Javadoc，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/2375841/