Используя IntelliJ IDEA 15, как я могу найти общедоступные методы, в которых отсутствует javadoc и, следовательно, привести к снижению показателя SonarQube Public Documented API, как показано здесь?
IntelliJ — найти недокументированные общедоступные методы
Ответы (1)
В IntelliJ есть возможность проверки кода.
1. Настройте параметры проверки
Чтобы определить отсутствующую общедоступную документацию, сначала включите проблему Декларация имеет проблемы с Javadoc. Для этого откройте настройки IDE и выберите Editor -> Inspections. В правом меню выберите Java -> Проблемы с Javadoc -> Объявление о проблемах с Javadoc. Активируйте эту проблему.
Опять же, в правом нижнем углу вы увидите несколько вариантов решения этой проблемы. Убедитесь, что для вкладки Метод параметр Область установлен на общедоступный. Также установите флажок Игнорировать простой доступ к свойствам, поскольку вы не хотите получать информацию о том, что методы получения и установки не имеют документации.
Нажмите ОК, чтобы сохранить.
2. Проверьте код
В верхней строке меню в IntelliJ откройте Анализ -> Проверка кода..., выберите объем проверки и запустите ее, нажав ОК. В разделе Результаты проверки найдите Проблемы с Javadoc -> Декларация имеет проблемы с Javadoc. Те проблемы, в которых говорится, что Необходимый документ Javadoc отсутствует, — это то, что вы ищете.
person
michaelbahr
schedule
07.12.2015
