1

如何从 javadoc 中排除受保护的方法？

我需要记录一些但不是所有受保护的方法。

谢谢

4

3 回答 3

0

您可以使用命令行选项"-protected"排除所有受保护的方法，但我只是更仔细地重新阅读了您的问题，并意识到这可能不是您想要的。

于 2013-07-16T15:34:51.690 回答
0

您不能使用直接的 Javadoc 来执行此操作，但是，根据您需要的其他 javadoc 工具以及生成 javadoc 的方式，您可以考虑切换到Doclava。Doclava 是一个用于 javadoc 的 doclet（想想：插件），它可以识别 @hide 标签。

HTML 输出也更漂亮。

不幸的是，它不能识别大量的 javadoc 命令行选项，因此它可能不适合。

https://code.google.com/p/doclava/

于 2013-08-07T13:13:13.353 回答
0

如果您使用的是 maven 插件，您可以在配置标签中使用show标签，其值为public，如下所示。在这种情况下，只有类的公共成员才会显示到 javadoc 中。

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.10.1</version>
            <configuration>
                <show>public</show>
                <doctitle>My company API</doctitle>
                <subpackages>my.company.package.api</subpackages>
            </configuration>
        </plugin>
于 2016-06-09T12:51:04.950 回答