Jump to content

ВСдокман

ВСдокман
Разработчик(и) Хеликсофт
Стабильная версия
11,0 / 16 декабря 2021 г. ( 2021-12-16 )
Операционная система Окна
Тип Генератор документации
Лицензия Собственный
Веб-сайт 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 ]

См. также

[ редактировать ]
[ редактировать ]


Arc.Ask3.Ru: конец переведенного документа.
Arc.Ask3.Ru
Номер скриншота №: bddc53a5a3167f9257c50bd2af5a6469__1639747860
URL1:https://arc.ask3.ru/arc/aa/bd/69/bddc53a5a3167f9257c50bd2af5a6469.html
Заголовок, (Title) документа по адресу, URL1:
VSdocman - Wikipedia
Данный printscreen веб страницы (снимок веб страницы, скриншот веб страницы), визуально-программная копия документа расположенного по адресу URL1 и сохраненная в файл, имеет: квалифицированную, усовершенствованную (подтверждены: метки времени, валидность сертификата), открепленную ЭЦП (приложена к данному файлу), что может быть использовано для подтверждения содержания и факта существования документа в этот момент времени. Права на данный скриншот принадлежат администрации Ask3.ru, использование в качестве доказательства только с письменного разрешения правообладателя скриншота. Администрация Ask3.ru не несет ответственности за информацию размещенную на данном скриншоте. Права на прочие зарегистрированные элементы любого права, изображенные на снимках принадлежат их владельцам. Качество перевода предоставляется как есть. Любые претензии, иски не могут быть предъявлены. Если вы не согласны с любым пунктом перечисленным выше, вы не можете использовать данный сайт и информация размещенную на нем (сайте/странице), немедленно покиньте данный сайт. В случае нарушения любого пункта перечисленного выше, штраф 55! (Пятьдесят пять факториал, Денежную единицу (имеющую самостоятельную стоимость) можете выбрать самостоятельно, выплаичвается товарами в течение 7 дней с момента нарушения.)