Checkstyle, JavaDoc не для getter, а setter работает только для getter - PullRequest
Новая
       29

Checkstyle, JavaDoc не для getter, а setter работает только для getter

0 голосов
/ 31 марта 2012

Я использую Eclipse Checkstyleplugin (v5.5).Мне нужны комментарии JavaDoc для всех открытых методов, кроме методов получения и установки.Я знаю, что есть опция "allowMissingPropertyJavadoc", которая делает именно то, что я хочу.Но в некоторых случаях это работает, а в некоторых - нет. Это работает, JavaDoc не требуется для gettes и сеттеров: 

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;
    }

}

И это не так, 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);
    }

}

Кажется, что сеттеры без назначения не распознаются как сеттеры.Это как я могу это исправить?

1 Ответ

3 голосов
/ 22 ноября 2012

Это потому, что для этого требуется, чтобы тело было в точности "this.name = name;"

Вы можете увидеть точно такую ​​строку здесь: http://checkstyle.hg.sourceforge.net/hgweb/checkstyle/checkstyle/file/a485366ec8c3/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java#l819

Тупой, я знаю.

...