Использование docfx.console не может генерировать документацию

Question

Я установил docfx.console через менеджер пакетов nuget (visual studios 2017 15.7.3) в тестовый проект. Мой проект - это библиотека.net с единичным классом с небольшим количеством XML-документации. Когда я собираю проект, он создает файл _site с файлом.html, но без документации. Он также генерирует папку api, apidoc и статьи и файл docfx.json.

Проект выдает предупреждение: невозможно найти ни toc.yml, ни toc.md внутри obj/api/. Убедитесь, что файл включен в конфигурационный файл docfx.json!

Я обнаружил несколько похожих проблем в github, который посоветовал установить версию Visual Studio на 2015 год, однако, насколько я могу судить, это решение не работает с docfx.console. Кто-нибудь знает, как я мог бы исправить эту проблему? Спасибо

Answer 1

Я также наткнулся на эту проблему, когда документировал существующее решение VB.net. Не зная, как выглядит ваш файл docfx.json или написана ли ваша библиотека.NET на C# или VB.net, я могу только дать ответ, который устранил мою проблему и, возможно, поможет с вашей.

Для меня при установке docfx через nuget файл docfx.json по умолчанию настроен на использование с проектами C#, а не с проектами VB.Net.

Я легко исправил это, изменив файл docfx.json и изменив расширение источника метаданных для поиска *.vbproj:

  "metadata": [
{
  "src": [
    {
      "files": [
        "*.vbproj"
      ],
      "cwd": ".",
      "exclude": [
        "**/obj/**",
        "**/bin/**",
        "_site/**"
      ]
    }
  ],
  "dest": "obj/api"
}],