Данная статья посвящена небольшому обзору DocumentInsight V3.4.10. Пока сам разбирался в чем суть да дело – решил написать краткий обзор – и сам лучше запомнишь, и другие прочитают, и в любой момент можно вернуться к своим же записям. Если по каким-то причинам у Вас его нет на борту – можно просто скачать установщик с официального сайта и проинсталлировать данное удовольствие.
Триальная версия дается на 15 дней, когда триал заканчивается – большая часть необходимых функций остается, но кое-что отключается, например нельзя выгружать документацию во внешние файлы – html, chm и так далее.
В качестве основы для обзора я взял видео с официального сайта.
После установки у нас в верхнем меню появляется пункт Documentation.
Самый главный пункт это Documentation Inspector – именно он будет нашим верным спутником и помощником, на протяжении всего времени написания проекта.
Что получим на выходе?
Результатом DocumentInsight будут либо вот такие сниппеты
Либо полноразмерная документация, вот пример html, но эта генерация доступна в триальной весрии в течение 15 дней.
Также доступны другие форматы при генерации документации на экспорт.
Как документировать свою программу?
Жмем Ctrl+Shift+D и у нас всплывает вот такое вот Docable окно Documentation Inspector – я прицепил его к левой части экрана
Далее мышкой кликаем на нужную нам функцию, переменную, класс, что угодно и заполняем слева поля. При этом, параллельно справа DocumentInsight пишет прямо в коде, в формате XML.
В результате, при использовании, например своего класса – можем лицезреть такую картину
Сворачивание комментариев документации в коде
Как видно, если документировать все подробно – получим ворох “буков”! Чтобы этого избежать – есть 2 классные функции
Documentation > FoldDocumentation – сворачивает все комментарии документации в юните – отдельные можно развернуть.
Documentation > UnfoldDocumentation – разворачивает все комментарии документации.
При сворачивании будем видеть такую картину
Генерация (экспорт) документации
Documentation > Generate
Далее проходим через окна настроек и на выходе получаем документацию в нужных нам форматах. Её можно найти в папке проекта, в подпапке Doc.
Общий вывод
Видно, что люди поработали, потратили свое время, чтобы всё это работало на результат. На мой взгляд, просто, доступно, удобно, MustHave.