Содержание
- Что такое Javadoc
- Структура Javadoc
- Javadoc-комментарии
- Типы тегов
- Блочные теги
- Общие теги
- Теги методов
- Строчные теги
- Ссылки
- Код и значения
- Применение Javadoc
- Объекты документирования
- Наследование Javadoc
- Компиляция Javadoc
Примеры
zipДомашнее задание 7. Javadoc
Это домашнее задание связано с двумя предыдущими и будет приниматься только с ними. Предыдущие домашнее задание отдельно сдать будет нельзя.
-
Документируйте класс
Implementor
и сопутствующие классы с применением Javadoc.-
Должны быть документированы все классы и все члены классов,
в том числе
private
. - Документация должна генерироваться без предупреждений.
-
Сгенерированная документация должна содержать корректные
ссылки на классы стандартной библиотеки и модулей
info.kgeorgiy.java.advanced.*
.
-
Должны быть документированы все классы и все члены классов,
в том числе
-
Для проверки, кроме исходного кода, также должны быть представлены:
- скрипт для генерации документации (он может рассчитывать, что рядом с вашим репозиторием склонирован репозиторий курса);
- сгенерированная документация.
В последующих домашних заданиях все public
и
protected
сущности должны быть документированы.