Как я могу сгенерировать документацию для C#, которая выводится как Markdown для Azure DevOps Wiki? - PullRequest
1 голос
/ 04 февраля 2020

Я использовал DocFX для генерации документации кода для C# и по большей части добился большого успеха с ним. Статьи являются гибкими, и мне действительно нравится, что я могу использовать markdown, чтобы поддерживать их, поддерживая их рядом со ссылками API. Я также уже потратил время на документирование пошаговых инструкций в Markdown и создание конвейера CI.

Проблема, которую я пытаюсь решить, заключается в том, что мне нужно найти способ получить документацию по коду (xml комментарии) вывод должен быть markdown вместо html, чтобы его можно было разместить в wiki-решении markdown, в частности Azure DevOps (он же TFS). Azure DevOps Wiki, похоже, очень похожа на gh-страницы из GitHub, поэтому меня интересуют аналогичные решения, которые я мог бы использовать в Azure DevOps. DocFX не решает эту проблему, потому что вывод: html вместо уценки .

Вся документация Microsoft сосредоточена на написании документации вручную. Я заинтересован в создании документации на основе xml комментариев в коде.

1 Ответ

1 голос
/ 05 февраля 2020

Похоже, это длинный открытый запрос на DocFx .

Это альтернативное решение было рекомендовано в нескольких местах, которые я видел XmlDocMarkdown .

Консольное приложение, которое генерирует Markdown из. NET XML комментарии к документации.

Или вы всегда можете go с Pando c. Либо с помощью конвертации акций, либо используйте свой собственный фильтр LUA для процесса конвертации.

...