Javadoc

@see: ccылка на другие классы
ссылка на документацию к другим классам. Javadoc не проверяет передаваемые ему гиперссылки. не See Also

    @see имя класса
    @see полное-имя-класса
    @see полное-имя-класса#имя-метод
    
{@link  пакет.класс#член_класс метка}
    похож на @see. Встроенный. Текст в поле метка
    

{@docRoot}
Позволяет получить относильный пусть к корневой папке, где находится документация.
Полезен при явном задании ссылок на страницы из дерева документацуии

{@inheritDoc}
Наследует документацию базового класса, ближайшего к документируемому классу, в текущий файл с документацией.

@version
Имеет форму:
    @version информация-о-версии
    Поле содержит ту информацию, которую вы сочли нужным включить.
    с опцией «-version» javadoc отводит место, заполняемое информацие о версиях.
    
@author
    информация об авторе или группе авторов.
    

@since
    Тег позволяет указать версию кода, с которой началось использование некоторой возможности.
    
@param
    документирование метода
    @param имя параметра описание
    
@return

@throws
параметры:
 полное-имя-класса  Уникальное имя класса исключения
 описание            Почему данный метод может создавать исключение при вызове.

@deprecated
    В будущем будут убраны определенный средства.

Реклама

Добавить комментарий

Заполните поля или щелкните по значку, чтобы оставить свой комментарий:

Логотип WordPress.com

Для комментария используется ваша учётная запись WordPress.com. Выход / Изменить )

Фотография Twitter

Для комментария используется ваша учётная запись Twitter. Выход / Изменить )

Фотография Facebook

Для комментария используется ваша учётная запись Facebook. Выход / Изменить )

Google+ photo

Для комментария используется ваша учётная запись Google+. Выход / Изменить )

Connecting to %s