Интерфейс ParamTag

Все суперинтерфейсы:: Tag

@Deprecated(since="9",
            forRemoval=true)
public interface ParamTag
extends Tag

Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии.

Объявления в этом пакете заменены объявлениями в пакете jdk.javadoc.doclet. Для получения дополнительной информации см. Руководство по миграции в документации по этому пакету.

Представляет тег документации @param. Хранит имя и комментарий части тега параметра. Тег @param может представлять параметр метода или конструктора, или параметр типа.

Методы

Модификатор и тип Метод Описание

Модификатор и тип	Метод	Описание
`boolean`	`isTypeParameter()`	Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает true, если этот `ParamTag` соответствует параметру типа.
`String`	`parameterComment()`	Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает комментарий к параметру, связанный с этим `ParamTag`.
`String`	`parameterName()`	Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает имя параметра или параметра типа, связанного с этим `ParamTag`.

boolean

isTypeParameter()

Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии.

Возвращает true, если этот ParamTag соответствует параметру типа.

String

parameterComment()

Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии.

Возвращает комментарий к параметру, связанный с этим ParamTag.

String

parameterName()

Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии.

Возвращает имя параметра или параметра типа, связанного с этим ParamTag.

Методы, объявленные в интерфейсе com.sun.javadoc.Tag

firstSentenceTags, holder, inlineTags, kind, name, position, text, toString

Методы

parameterName

String parameterName()

Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии.

Возвращает имя параметра или параметра типа, связанного с этим ParamTag. Фигурные скобки, ограничивающие параметр типа, не являются частью его имени.

Возвращает:: имя параметра.

parameterComment

String parameterComment()

Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии.

Возвращает комментарий к параметру, связанный с этим ParamTag.

Возвращает:: комментарий к параметру.

isTypeParameter

boolean isTypeParameter()

Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии.

Возвращает true, если этот ParamTag соответствует параметру типа. Возвращает false, если он соответствует обычному параметру метода или конструктора.

Возвращает:: true, если этот ParamTag соответствует параметру типа.
С:: 1.5