java - 自定义 PMD 规则 - 检查包注释到位

Question

我正在尝试编写一个规则来强制一个包包含带有特定表达式的 Javadoc 注释，例如：

/**
 * Example Expression
 */

有谁知道我将如何使用AbstractJavaRule类编写这样的规则。我看过 ASTPackageDeclaration，但这似乎没有我想要的。

提前谢谢了...

Answer 1

PMD 使用 JavaCC 将每个 java 文件解析为抽象语法树。通常用于编译的解析器只会删除注释，并且从我可以在“如何编写规则”页面上收集到的内容中，PMD 也会从 AST 中删除注释。

但是查看 PMD 论坛，看起来评论确实保留为 SPECIAL_TOKEN，但很难将它们与它们关联的 AST 节点对齐。所以你可能很难写出这条规则。你看过Checkstyle吗？它有一个RegexpHeader 规则，可以做你想做的事。