Пользовательские 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, который может делать то, что вы хотите.