声纳javadoc规则

Question

目前，我正在使用Sonar内部库重写校验样式规则JavadocStyle。但我面临一个问题--即使方法或类没有javadoc，规则也会在noMainDescription()上抛出真值。我正在使用用于获取javadoc信息的声呐javadoc类。这是我的考试课：

​

​

这就是我在声纳里得到的：

​

​

我的任务之一是检查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仍然会为字符串行变量添加空间。规则检查行中是否存在变量和创建空间规则后，认为存在javadoc，并且它是空的。