Javadoc

Материал из Википедии — свободной энциклопедии

Javadoc
Тип	Генератор документации
Разработчик	Sun Microsystems
ОС	кроссплатформенная
Текущая версия	1.50
Лицензия
Сайт	Официальный сайт

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

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

[править] Пример

Пример использования разметки Javadoc для документирования метода.

/**
 * Проверяет, допустимый ли ход.
 * Например, чтобы задать ход e2-e4, напишите isValidMove(5,2,5,4);
 * @author John Doe
 * @param theFromFile Вертикаль, на котором находится фигура
 * @param theFromRank Горизонталь, на которой находится фигура
 * @param theToFile   Вертикаль клетки, на которую выполняется ход
 * @param theToRank   Горизонталь клетки, на которую выполняется ход
 * @return true, если ход допустим, и false, если недопустим
 */
 boolean isValidMove(int theFromFile, int theFromRank, int theToFile, int theToRank)
 {
     …
 }