ВСдокман
![]() | В этой статье есть несколько проблем. Пожалуйста, помогите улучшить его или обсудите эти проблемы на странице обсуждения . ( Узнайте, как и когда удалять эти шаблонные сообщения )
|
![]() | |
Разработчик(и) | Хеликсофт |
---|---|
Стабильная версия | 11,0
/ 16 декабря 2021 г. |
Операционная система | Окна |
Тип | Генератор документации |
Лицензия | Собственный |
Веб-сайт | https://www.helixoft.com |
VSdocman — это генератор документации , который позволяет комментировать код и автоматически создавать техническую документацию из проектов C# и VB .NET . Он напрямую интегрирован в Visual Studio как расширение.
Обзор
[ редактировать ]VSdocman — расширение для Visual Studio 2022, 2019 и 2017. Оно состоит из двух основных частей — компилятора документации и редактора комментариев. Компилятор создает окончательную документацию класса в различных форматах. Редактор комментариев предоставляет инструменты для полуавтоматической вставки или редактирования комментариев XML, используемых компилятором. [ 1 ]
Составитель документации
[ редактировать ]На основе пользовательских настроек VSdocman сканирует код в проектах Visual Studio и автоматически создает документацию . Это можно сделать непосредственно из пользовательского интерфейса VS или из командной строки, например, при автоматической сборке. Документация соответствует стилю MSDN с оглавлением , указателем , документацией по классам API и настраиваемыми темами, перекрестными ссылками , поиском, IntelliSense F1 и контекстно-зависимой справкой . [ 2 ]
Поскольку компилятор имеет доступ к проекту Visual Studio, он также может включать исходный код и диаграммы классов в документацию (файлы .cd). Проекты могут документироваться отдельно или может быть создана единая документация для всего решения. [ 3 ]
Формат выходной документации настраивается. Предопределенные форматы:
Вывод может быть локализован, некоторые языки уже включены. [ 4 ]
Редактор комментариев
[ редактировать ]VSdocman может читать XML-комментарии из исходного кода . Редактирование комментариев вручную может оказаться сложной задачей. Поэтому он содержит редактор комментариев WYSIWYG , который помогает писать комментарии XML и собственные темы. Есть возможность вставлять таблицы, списки, картинки, диаграммы классов, ссылки и другое форматирование непосредственно в исходный код. В зависимости от типа элемента кода пользователь может указать для него комментарий по умолчанию. Этот комментарий будет автоматически добавлен, когда пользователь добавляет или редактирует комментарий в первый раз. Например, для логических свойств автоматически создается сводный текст «Получает или задает значение, указывающее, является ли...». [ 5 ]
История
[ редактировать ]Первоначально VSdocman назывался VBdocman .NET, поскольку он произошел от VBdocman . VBdocman .NET поддерживает только Visual Basic .NET. Он был переименован в VSdocman после добавления поддержки C# в 2006 году. [ 6 ]
См. также
[ редактировать ]Ссылки
[ редактировать ]Внешние ссылки
[ редактировать ]