自定義PMD規則-檢查包注釋到位

Question

我正在嘗試編寫一條規則，以強制程序包包含帶有特定表達式的Javadoc注釋，例如：

/**
 * Example Expression
 */

有人知道我將如何使用AbstractJavaRule類編寫這樣的規則。 我看過ASTPackageDeclaration，但這似乎沒有我想要的。

提前謝謝了...

Answer 1

PMD使用JavaCC將每個Java文件解析為抽象語法樹。 通常，用於編譯的解析器只會刪除注釋，而根據我在“如何編寫規則”頁面上的了解，PMD也會從AST刪除注釋。

但是在PMD論壇上，看起來確實將注釋保留為SPECIAL_TOKEN ，但是很難將其與它們關聯的AST節點對齊。 因此，您可能很難編寫此規則。 您是否看過Checkstyle ？ 它具有RegexpHeader規則 ， 可以滿足您的要求。