Игнорировать отсутствующую документацию, если у суперкласса есть документация

Есть ли способ указать SonarQube не учитывать переопределяющий метод в общедоступной документированной статистике API, если переопределенный метод задокументирован? SonarQube находит многие методы без аннотаций из-за приведенного ниже случая.

введите здесь описание изображения

Я знаю, что есть аннотация для игнорирования определенных правил SonarQube, однако мы не хотим добавлять код в наш проект, чтобы удовлетворить требования SonarQube.


java sonarqube documentation javadoc sonarqube-4.5
person michaelbahr    schedule 03.12.2015    source источник
comment
Я не вижу изображения, но правильно ли аннотирован метод переопределения @Override?   -  person Tunaki    schedule 03.12.2015
comment
Я проверю это в понедельник. На картинке показан график из SonarQube с проблемами и общедоступным документированным API, что не очень необходимо.   -  person michaelbahr    schedule 04.12.2015
comment
@Tunaki методы правильно аннотированы.   -  person michaelbahr    schedule 07.12.2015

Ответы (1)


arrow_upward
3
arrow_downward

Вы можете использовать наследование doc.

/**
 * {@inheritDoc}
 */
@Override
person StackFlowed    schedule 03.12.2015
comment
В ходе дальнейшего расследования я наткнулся на правило проверки IntelliJ IDEA, которое гласит: «Сообщает о любых комментариях Javadoc, которые содержат только тег {@inheritDoc}». Поскольку Javadoc копирует комментарий суперкласса, если комментарий отсутствует, комментарий, содержащий только {@inheritDoc}, ничего не добавляет. Разве SonarQube не может обнаружить такое поведение? - person michaelbahr; 07.12.2015