Java 8 - 使用 Doclet 自定义 Java 文档检查

Java 8 - Custom JavaDoc check using Doclet

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

import com.sun.javadoc.*;

public class CheckingDoclet extends Doclet {

问题 com.sun.javadoc 已删除,将仅在 java 9 (which means using at least java 10)

中替换

The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.

有没有使用Java8的替代品?

编辑

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

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

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

我建议使用 JavaDoc 检查你的 ide(我的是 eclipse)——还有 CheckStyle and PMD.

对于这三个你应该做你自己的配置!

在 eclipse 中,您可以在 Windows/Preferences/Java/Compiler/Javadoc

找到 JavaDocs 的配置

如果您有这些工具无法满足的特殊要求 - 那么请忘记 Eclipse。 您唯一的机会是为 CheckStyle 或 PMD 编写您自己的扩展。 例如参见 [​​=11=].

顺便说一句。也不建议使用 java 内部 api - 参见 。据我所知,这些 api 将在 Java 9/10/11+ 后消失。所以不建议使用。