Тема  6. Javadoc

Содержание

  1. Что такое Javadoc
  2. Структура Javadoc
    1. Javadoc-комментарии
    2. Типы тегов
  3. Блочные теги
    1. Общие теги
    2. Теги методов
  4. Строчные теги
    1. Ссылки
    2. Код и значения
  5. Применение Javadoc
    1. Объекты документирования
    2. Наследование Javadoc
  6. Компиляция Javadoc

Слайды

HTML

Примеры

zip

Домашнее задание 6. Javadoc

Это домашнее задание связано с двумя предыдущими и будет приниматься только с ними. Предыдущие домашнее задание отдельно сдать будет нельзя.

  1. Документируйте класс Implementor и сопутствующие классы с применением Javadoc.
    • Должны быть документированы все классы и все члены классов, в том числе private.
    • Документация должна генерироваться без предупреждений.
    • Сгенерированная документация должна содержать корректные ссылки на классы стандартной библиотеки и модуля info.kgeorgiy.java.advanced.implementor.
  2. Для проверки, кроме исходного кода так же должны быть представлены:
    • скрипт для генерации документации;
    • сгенерированная документация.