Question

我正在使用Eclipse Checkstyleplugin（v5.5）。我想要除getter和setter之外的所有公共方法的JavaDoc注释。我知道有一个选项“allowMissingPropertyJavadoc”，它完全符合我的要求。但在某些情况下，它有效，有些情况则不然
这样可行，gettes和setter不需要JavaDoc：

public class Test {
    private String name;
    private int number;

    public Test() {
        System.out.println("Test");
    }

    public String getName() {
        return this.name;
    }

    public int getNumber() {
        return this.number;
    }

    public void setName(String name){
        this.name = name;
    }

    public void setNumber(int number) {
        this.number = number;
    }

}

这不是，在setter上需要JavaDoc：

public class Test2 {

    private Test test;

    public Test2() {
        System.out.println("Test2");
        this.test = new Test();
        this.test.setName("thename");
        this.test.setNumber(1337);
    }

    public String getName() {
        return this.test.getName();
    }

    public int getNumber() {
        return this.test.getNumber();
    }

    public void setName(String name) {
        this.test.setName(name);
    }

    public void setNumber(int number) {
        this.test.setNumber(number);
    }

}

似乎没有作业的设定者不会被识别为设定者。我该如何解决这个问题？

Answer 1

那是因为它要求身体正好是“this.name = name;”

你可以看到这里的确切线： http://checkstyle.hg.sourceforge.net/hgweb/checkstyle/checkstyle/file/a485366ec8c3/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java#l819

傻，我知道。

Checkstyle，没有用于getter和setter的JavaDoc仅适用于getter

1 个答案: