Javadoc

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

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

Пример

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

<source lang=java5>

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

</source>

См. также

• Список генераторов документации
• Doxygen
• Epydoc
• Генератор документации

Ссылки

• Официальный сайт утилиты Javadoc
• Различная Java-документация, конвертированная в формат Windows Help
• Документация по Java 1.6 в формате Javadoc (на английском)

Статьи

• Теория и практика Java: Мне нужно задокументировать ЭТО?
• Skipy.ru: Записки трезвого практика -> Полезное -> Создание собственных тегов javadoc