На этом уроке мы займёмся документированием созданных классов и методов. Мы будем использовать javadoc-стиль для автоматизации процесса создания документации.
Дата отправки отчёта:
14 апреля 2017 г.
Задание выполнено: за
30 мин.
Чему научился:
Писать комментарии
Что было сложным:
Писать комментарии на английском. Через неделю ничего не понятно и проще заглянуть в код.
Комментарии:
В качестве переводчика удобно использовать, может с непривычки начинает рябить в глазах от лишнего текста (особенно в конфигах, где пояснений больше, чем настраиваемых параметров). По мне, так должно быть наоборот: для каждого выбранного класса формироваться табличка, куда можно добавить комментарии и откуда будут браться подсказки.
Научился: Создавать документацию с помощью утилиты javadoc Трудности: Сложностей не возникло. Это просто фантастика.
Почему-то мне не пришлось указывать кодидровку, документация создалась без проблем, правда, пришлось указывать полный путь к утилите javadoc, по называнию файла она не запускалась.
Спасибо за урок.
