Java 8 - 使用 Doclet 的自定义 JavaDoc 检查

Question

我对验证 JavaDoc 很感兴趣，我发现了这个 answer 的自定义检查：

import com.sun.javadoc.*;

public class CheckingDoclet extends Doclet {

问题com.sun.javadoc已被删除，将仅在java 9中替换（这意味着至少使用java 10）

此包中的声明已被包 jdk.javadoc.doclet 中的声明所取代。有关详细信息，请参阅该软件包文档中的迁移指南。

有没有使用 Java 8 的替代品？

编辑

我需要一个新的检查来阻止块标记后的描述，

在checkstyle中没有这样的规则，需要create a new check

在 PMD 中没有这样的规则，可能需要create a new check

Answer 1

我建议使用您的 ide（我的是 eclipse）以及 CheckStyle 和 PMD 的 JavaDoc 检查。

对于这三个，您应该进行自己的配置！

在 Eclipse 中，您可以在 Windows/Preferences/Java/Compiler/Javadoc 找到 JavaDocs 的配置

如果您有这些工具无法满足的特殊要求 - 那就忘掉eclipse吧。 您唯一的机会是为 CheckStyle 或 PMD 编写自己的扩展。 例如参见Writing CheckStyle checks。

顺便说一句。也不建议使用 java 内部 api - 请参阅Stackoverflow About Java 8 Doclets。据我所知，这些 api 将在 Java 9/10/11+ 中消失。所以不建议使用。