Java руководство для начинающих - Шилдт Герберт (2012)

Дескриптор @author описывает автора класса или интерфейса и имеет следующий

синтаксис:

@author описание

где описание, как правило, обозначает имя автора. Для того чтобы сведения, указываемые в поле @author, были включены в результирующий HTML-документ, при вызове

утилиты javadoc из командной строки следует указать параметр -author.

Дескриптор {@code}

Дескриптор {@code} позволяет включать в комментарии текст, в том числе и отдельные фрагменты кода. Такой текст будет выводиться специальным шрифтом, используемым для форматирования кода, и не подлежит дальнейшей обработке по правилам форматирования HTML-документов. Этот дескриптор имеет следующий синтаксис:

{0code фрагмент_кода}

Дескриптор @deprecated

Дескриптор @deprecated указывает на то, что класс, интерфейс или метод не рекомендован к применению. В описание рекомендуется включать дескриптор 0see или

{@link}, чтобы уведомить программиста о других возможных решениях. У этого дескриптора имеется следующий синтаксис:

@deprecated описание

где описание обозначает сообщение, описывающее причины, по которым данное

языковое средство Java не рекомендуется к применению. Дескриптор @deprecated

можно применять для документирования полей, методов, конструкторов, классов и

интерфейсов.

Дескриптор {@docRoot}

Дескриптор {@docRoot} указывает путь к корневому каталогу документации.

Дескриптор @exception

Дескриптор ©exception описывает исключение, которое может возникнуть при выполнении метода. У него имеется следующий синтаксис:

©exception имяисключения пояснение

где имяисключения обозначает полностью определенное имя исключения, а

пояснение — символьную строку, в которой поясняется, при каких условиях исключение может возникнуть. Дескриптор ©exception можно применять только для документирования методов.

Дескриптор {@inheritDoc}

Этот дескриптор наследует комментарии от ближайшего суперкласса.

Дескриптор {@link}

Дескриптор {01ink} предоставляет встраиваемую ссылку на дополнительные сведения. У него имеется следующий синтаксис:

{01ink пакет.класс#член текст}

где пакет. класс#член обозначает имя класса или метода, на который делается встраиваемая ссылка, а текст — символьную строку, отображаемую в виде встраиваемой

ссылки.

Дескриптор {@linkplain}

Дескриптор {01inkplain} вставляет встраиваемую ссылку на другую тему. Эта

ссылка отображается обычным шрифтом. А в остальном данный дескриптор подобен

дескриптору {01 i n к}.

Дескриптор {@literal}

Дескриптор {©literal} позволяет включать текст в комментарии. Этот текст

отображается без дополнительной обработки по правилам форматирования HTML-

документов. У него имеется следующий синтаксис:

©literal описание

где описание обозначает текст, включаемый в комментарии.

Дескриптор @param

Дескриптор @param описывает параметр. У него имеется следующий синтаксис:

©parameter имяпараметра пояснение

где имяпараметра обозначает конкретное наименование параметра, а пояснение —

поясняемое назначение параметра. Дескриптор ©param можно применять для документирования метода, конструктора, а также обобщенного класса или интерфейса.

Дескриптор @return

Дескриптор @return описывает значение, возвращаемое методом. У него имеется

следующий синтаксис:

@return пояснение

где пояснение обозначает тип и назначение возвращаемого значения. Дескриптор

@ return применяется только для документирования методов.

Дескриптор @see

Дескриптор @see предоставляет ссылку на дополнительные сведения. Ниже приведены две наиболее употребительные формы этого дескриптора.

@see ссылка

@see пакет.класс#член текст

В первой форме ссылка обозначает абсолютный или относительный веб-адрес (URL).