声纳javadoc规则

Question

目前，我正在使用Sonar内部库重写checkstyle规则JavadocStyle。但是我面临一个问题 - 即使方法或类没有javadoc，规则也会在noMainDescription（）上抛出true。我正在使用sonar javadoc class to get javadoc information。 这是我的测试类：

这是我在声纳中得到的：

我的一个任务是检查javadoc是否包含描述或是否为空并抛出违规。

我使用此代码进行检查：

@Override
public void visitNode(Tree tree) {
    Javadoc javadoc = new Javadoc(tree);
    String lines = String.join("  ", javadoc.javadocLines);

    // Javadoc description
    reportEmptyDescription(tree, javadoc);

}

public void reportEmptyDescription(Tree tree, Javadoc javadoc) {
    if (isDescriptionEmpty(javadoc)) {
        reportIssue(tree.firstToken(), "Javadoc has empty description section");
    }
    if (tree.is(Tree.Kind.METHOD) && ((MethodTree) tree).symbol().returnType().toString() != "void"
            && isReturnDescriptionEmpty(javadoc)) {
        reportIssue(tree.firstToken(), "Javadoc has empty return description");
    }
    if (tree.is(Tree.Kind.METHOD) && !((MethodTree) tree).parameters().isEmpty()
            && isParametersDescriptionEmpty(javadoc)) {
        reportIssue(tree.firstToken(), "Javadoc has empty parameters description");
    }
}

public boolean isDescriptionEmpty(Javadoc javadoc) {
    return javadoc.noMainDescription(); // check if it returns true when description exists
}

public boolean isReturnDescriptionEmpty(Javadoc javadoc) {
    return javadoc.noReturnDescription(); // check if it returns true when description exists
}

public boolean isParametersDescriptionEmpty(Javadoc javadoc) {
    if (javadoc.undocumentedParameters().isEmpty()) {
        return false;
    } else {
        return true;
    }
}

我的问题在第一次违规时显示：类没有javadocs，但规则读取它有但没有描述。

有没有办法防止这个问题？

Answer 1

我发现了这个问题。它来自这条线：

String lines = String.join("  ", javadoc.javadocLines);

当类或方法没有任何javadoc时，javadoc.javadocLines将不返回任何内容。但String.join仍会为String lines变量添加空间。规则检查后是否有行变量和创建空间规则认为有javadoc并且它是空的。