Question

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

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

由于

Answer 1

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

Answer 2

你不能用直接的Javadoc做到这一点，但是，根据你需要的其他javadoc设施，以及你是如何生成你的javadoc，你可以考虑切换到 Doclava 。 Doclava是javadoc的doclet（思考：插件），识别@hide标签。

HTML输出也更漂亮。

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

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

Answer 3

如果您使用的是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>

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

3 个答案: