c# - 如何从 javadoc 中排除某些类/包/公共(public)成员

Question

我创建了 java api - 更具体地说，是从 C# 移植的 - 除了公共(public)接口(interface)之外，它还包含许多我不希望用户知道的内部内容。在 C# 中，我使用 doxygen 来生成文档。我认为 javadoc 具有类似的功能来排除某些公共(public)成员、类，甚至包。

有人建议如何做到这一点，也许通过 eclipse 吗？

谢谢

Answer 1

我相信在 Eclipse 中，您可以指定的唯一排除类型是“排除所有 protected 成员”和基于包的排除(不是基于类的排除。)

如果您使用 Ant 生成它们，则可以使用嵌套的“package”元素，并且可以使用文件集嵌套元素并向该文件集添加排除项。

例如:

<javadoc >
    <sourcefiles>
          <fileset dir="${src}">
              <include name="**/*.java"/>
              <exclude name="**/ClassToExclude.java"/>
          </fileset>
    </sourcefiles>
    <packageset>
          <dirset dir="${src}">
              <include name="com.mydomain.*"/>
              <exclude name="com.mydomain.excludePackage"/>
          </dirset>
     </packageset>
</javadoc>

附注- 我用过<sourcefiles>元素很多，但从来没有 <packageset>元素。后者在语法上可能不准确。