Как сгенерировать документацию с помощью DocFX, используя файл документации XML?

Question

Я хочу создать что-то вроде веб-сайта с документацией по API для проекта.NET. Согласно .NET Docs, XML-комментарии, которые мы помещаем поверх методов, классов и т. Д., Могут быть обработаны компилятором в XML-файл, и этот файл можно запустить с помощью таких инструментов, как DocFX, для создания веб-сайта документации. .NET Docs не предоставляет никаких инструкций для последнего, а документация DocFX также не дает никаких подсказок о том, как использовать этот XML-файл для создания веб-сайта документации API.

Любые идеи о том, как я могу использовать этот файл XML с DocFX для создания веб-сайта документации API?

Answer 1

Если вы используете.NET Core 2.2 или выше, вы можете обновить свой docfx.json для прямого извлечения метаданных из .dll а также .xml.

DocFX "будет искать XML-файл в той же папке" с тем же именем, что и.dll.

Пример:

{
  "metadata": [
    {
      "src": "bin/Release/netstandard2.0/YourCompany.YourNamespace.dll",
      "dest": "obj/api"
    }
  ]
}

Вы также должны включить <GenerateDocumentationFile>true</GenerateDocumentationFile> в ваш .csproj файл.

Answer 2

Для всех, кто сталкивается с этим, DocFX можно использовать напрямую из Visual Studio 2017 и более поздних версий:

• Установите docfx.console Пакет NuGet для проекта, содержащий XML-документацию.
• При построении проекта _site папка будет создана в той же папке, где находится проект .csprojфайл находится. Эта папка содержит документацию (доступ черезindex.html файл).

---

Источник: Документация DocFX.