java自定义PMD规则就地检查包注释

Question

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

/**
 * Example Expression
 */

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

非常感谢

Answer 1

PMD使用JavaCC将每个java文件解析为抽象语法树。通常用于编译的解析器只会删除注释，从我在"How to write a rule"页面上收集的信息来看，PMD也会删除来自AST的注释

但是看看PMD论坛，它看起来确实像comments are preserved as a SPECIAL_TOKEN，但是很难将它们与它们关联的AST节点对齐。所以你可能很难写出这条规则。你看过Checkstyle了吗？它有一个RegexpHeader rule可以做你想做的事