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

Question

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

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

---

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