Интернет магазин китайских планшетных компьютеров



Компьютеры - Javadoc

01 мая 2011


Оглавление:
1. Javadoc
2. Пример



генератор документации в HTML-формате из комментариев исходного кода на Java от Sun Microsystems. Javadoc — стандарт для документирования классов Java. Большинство cред разработки программного обеспечения автоматически генерируют HTML-документацию, используя Javadoc.

Javadoc также предоставляет API для создания доклетов и тэглетов, которые позволяют программисту анализировать структуру Java-приложения.


Применение

Комментарии документации применяют для:

  • документирования классов,
  • интерфейсов,
  • полей,
  • конструкторов,
  • методов,
  • пакетов.

В каждом случае комментарий должен находиться перед документируемым элементом.

Список дескрипторов Javadoc
Дескриптор Описание Применим к
@author Автор класс, интерфейс
@version Версия. Не более одного дескриптора на класс класс, интерфейс
@since Указывает с какой версии доступно класс, интерфейс, поле, метод
@see Ссылка на другое место в документации класс, интерфейс, поле, метод
@param Входной параметр метода метод
@return Описание возвращаемого значения метод
@exception имякласса описание
@throws имякласса описание
Описание исключения которое может быть обработано внутри метода метод
@deprecated Описание устаревших блоков кода метод
{@link reference} Ссылка класс, интерфейс, поле, метод
{@value} Описание значения переменной статичное поле


Для документирования переменной можно использовать следующие дескрипторы: @see, @serial, @serialField, {@value}, @deprecated. Для классов и интерфейсов можно использовать дескрипторы: @see, @author, @deprecated, @param, @version. Методы можно документировать с помощью дескрипторов: @see, @return, @param, @deprecated, @throws, @serialData, {@inheritDoc}, @ехсерtiоn.

Дескрипторы {@link}, {@docRoot}, {@code}, {@literal}, @since, {@linkplain} могут применяться где угодно.



Просмотров: 1492


<<< JavaFX