Параметры Javadoc компилятора Java

Укажите параметры для Javadoc на странице параметров открывает страницу параметров Javadoc Java > Компилятор > Javadoc .

Опция

Описание

По умолчанию

Обработка комментариев Javadoc (включает в себя поиск и рефакторинг)

Если эта опция включена, компоновщик обнаруживает неполадки в комментариях Javadoc. Для того чтобы поиск и рефакторинг работали на комментариях Javadoc, также необходимо разрешить эту опцию.

Вкл.

Дефектные комментарии Javadoc

Если эта опция включена, компилятор выдает сообщение об ошибке или предупреждение при обнаружении дефектного комментария Javadoc.

Игнорировать

Учитывать только элементы, видимые как

Компилятор проверяет только элементы с указанной или более широкой областью видимости.

Public

Проверка аргументов тегов (@param, @throws, @exception, @see, @link)

Если эта опция включена, компилятор выдает ошибку или предупреждение при обнаружении ошибки аргументе тега комментария Javadoc для @param, @throws, @exception, @see или @link.

Выключена

Сообщать о невидимых ссылках

Если эта опция включена, компилятор выдает сообщения об ошибках или предупреждения при обнаружении ссылки на невидимый элемент.

Выключена

Сообщать об устаревших ссылках

Если эта опция включена, компилятор выдает сообщение об ошибке или предупреждение в случае обнаружения ссылки на устаревший элемент.

Выключена

Пропуски описаний тегов

Выберите 'Проверять все стандартные теги', 'Проверять теги @return' или 'Игнорировать'. Если эта опция включена, компилятор выдает сообщение об ошибке или предупреждение при обнаружении пропущенного описания тега.

'Проверять теги @return'

Отсутствующие теги Javadoc

Если эта опция включена, компилятор выдает сообщение об ошибке или предупреждение при обнаружении отсутствующего тега Javadoc (то есть отсутствующего тега @param для параметра).

Игнорировать

Учитывать только элементы, видимые как

Компилятор проверяет только элементы с указанной или более широкой областью видимости.

Public

Игнорировать в переопределяющих и реализующих методах

Если эта опция включена, методы, заменяющие или реализующие другой метод, не проверяется на отсутствие тегов Javadoc.

Вкл.

Игнорировать параметры типа метода

Если эта опция включена, для параметров типа метода не сообщается об отсутствующих тегах Javadoc.

Вкл.

Отсутствующие комментарии Javadoc

Если эта опция включена, компилятор выдает сообщение об ошибке или предупреждение в случае обнаружения отсутствующего комментария Javadoc для элемента Java.

Игнорировать

Учитывать только элементы, видимые как

Компилятор проверяет только элементы с указанной или более широкой областью видимости.

Public

Игнорировать в переопределяющих и реализующих методах

Если эта опция включена, методы, заменяющие или реализующие другой метод, не проверяется на отсутствие комментариев Javadoc.

Вкл.