live documenter
v2.1.53
Не позволяйте комментариям скрываться в исходном коде! Прочтите его, найдите и опубликуйте с помощью Live Documenter. Документация для .NET стала проще.
Live Documenter — это набор приложений и библиотек, которые обеспечивают просмотр в реальном времени и автоматическое создание документации из кода .NET и файлов комментариев XML. Узнайте, что такое Live Documenter, на нашей домашней странице и загрузите последнюю версию.
Просматривайте документацию в реальном времени и в актуальном состоянии!
Создавайте красивую статическую документацию.
Или используйте библиотеку API для интеграции в свои собственные проекты.
Live Documenter — это настольное приложение, консольная утилита и библиотека API, предназначенная для того, чтобы сделать ваш .NET-код и комментарии более читабельными и доступными. Давайте освободим их от ограничений XML, спрятанных в исходном коде, и найдем им хорошее применение!
Начните с загрузки последней версии и прочтения краткого руководства.
Настольное приложение позволяет открывать проекты, решения или библиотеки Visual Studio и создавать для них документацию из файлов комментариев XML в реальном времени. Если в базу кода вносятся изменения, они отражаются в приложении при перестроении проекта.
Он также предоставляет приятный интерфейс для экспорта документации, чтения и печати.
Приложение-экспортер полезно для интеграции создания документации в существующие процессы; например, ваши сценарии сборки или создание специальной документации.
DLL, на которую могут ссылаться проекты для автоматического создания документации во время выполнения. Подробности API и способы его использования можно найти в документации.
На данный момент это будет работать только в Windows, продолжается работа по переходу на netstandard и созданию кроссплатформенности всего, кроме настольных приложений, на .NET Core.
Предоставляется zip-файл последней версии. Для установки скачайте файл, разархивируйте и запустите из каталогов.
Требования
.NET Core SDK 3.1
Последняя версия кода была разработана в Visual Studio 2019, а некоторые проекты были перенесены в библиотеки netstandard и используют новейший формат файлов csproj.
Пожалуйста, дайте мне знать, если возникнут какие-либо проблемы при сборке исходного кода, чтобы я мог их решить.
Вся помощь приветствуется. Существует связанный сайт документации, который всегда можно улучшить.
Если вы хотите принять участие в проекте, пожалуйста, ознакомьтесь с текущими вопросами. Запишите свой интерес, получите последнюю версию и создайте запрос на включение, когда будете готовы объединить изменения.
Кроме того, простое предоставление обратной связи через вопросы GitHub помогает убедиться, что проект становится более стабильным и постоянно совершенствуется.
