Пользовательское правило PMD - проверить комментарий к пакету на месте

Question

Я пытаюсь написать правило для обеспечения того, чтобы пакет содержал комментарий Javadoc с определенным выражением, например:

/**
 * Example Expression
 */

Кто-нибудь знает, как я написал бы такое правило, используя класс AbstractJavaRule . Я посмотрел на ASTPackageDeclaration, но, похоже, он не соответствует тому, что я хочу.

Большое спасибо заранее ...

Answer 1

PMD использует JavaCC для анализа каждого файла Java в абстрактном синтаксическом дереве. Обычно парсеры, используемые для компиляции, просто сбрасывают комментарии, и из того, что я могу собрать на странице «Как написать правило» , PMD также отбрасывает комментарии из AST.

Но если посмотреть на форум PMD, то похоже, что комментарии сохраняются как SPECIAL_TOKEN , но их трудно сопоставить с узлом AST, с которым они связаны. Таким образом, вам может быть трудно написать это правило. Вы смотрели на Checkstyle вместо этого? У него есть правило RegexpHeader , которое может делать то, что вы хотите.