Можем ли мы выборочно генерировать XML документацию в Visual Studio? - PullRequest
0 голосов
/ 25 февраля 2020

Я, возможно, ищу атрибут или что-то, что я мог бы использовать, чтобы пометить «Я хочу это в моей xml документации», как белый список.

Ситуация такова, что я sh должен сгенерировать xml документацию для определенных контроллеров, которая будет отображаться в swagger. Тем не менее, многие вещи НЕ должны документироваться - особенно автоматически сгенерированный код, такой как типы прокси-серверов CRM, который содержит сотни тысяч нежелательных определений.

Я включил генерацию «Xml Документация» в настройках своего проекта и отключил предупреждение о недокументированных элементах publi c, поэтому автоматические сборки завершаются в разумные сроки, но Visual Studio генерирует 8.1mb xml файл документации, который Swagger долго загружает. 90% этого - автоматически сгенерированная ерунда прокси. Вместо этого я хочу сказать «задокументировать этот файл» в контроллерах, которые меня интересуют - возможно ли это?

1 Ответ

0 голосов
/ 25 февраля 2020

Я не знаю, как сделать это напрямую без какого-либо инструмента. Это можно сделать с помощью VSdocman (я его автор). Он может создать свой собственный XML do c файл . Затем вы можете настроить то, что нужно документировать, например, указать c файлы / папки, фильтры регулярных выражений для подписей и атрибутов, специальные возможности (public / private / ...), специальные XML do c tag и другие. .

...