Visual Studio macOS не может создать HTML-документацию для приложения Xamarin.Forms

Я создал приложение Xamarin.Forms на Mac и понимаю, что есть способ сгенерировать документацию по методам и классам в HTML. Но большинство инструментов, упомянутых в Интернете, похоже, не работают в Visual Studio для macOS.

Я попробовал рекомендуемые расширения eVisual Studio Extensions Версия Visual Studio для MacOS, похоже, не может реализовать расширения Visual Studio (файлы .vsix).

Есть ли способ создать документацию в Visual Studio? Или мне нужно переместить проект на компьютер с Windows с Visual Studio для создания документов?


person Tlink    schedule 11.03.2019    source источник


Ответы (1)


Существует ряд кроссплатформенных инструментов генерации HTML, которые поддерживают схему XML-документа, которую MSBuild создает с помощью:

  • глобально в решении через GenerateDocumentationFile в проп-файле
  • свойство DocumentationFile имени файла в отдельных проектах .csproj

Такие инструменты, как Doxygen, DocFX и т. д., работают в Windows|macOS|Linux, но эти инструменты за пределами Windows в основном основаны на командной строке.

Те, что я использую:

Сделайте Google/Bing для большего количества альтернатив.

person SushiHangover    schedule 11.03.2019
comment
Спасибо за отличный ответ, я установил docfx и использую его в терминале. Однако я не могу --обслуживать документы, я продолжаю получать много ошибок и предупреждений: PROJECT.csproj) Ошибка при открытии проекта PROJECT.csproj: не удалось загрузить тип поля «Microsoft.CodeAnalysis.SQLite.Interop.SqlConnection:_handle». ' (0) из-за: Не удалось загрузить файл или сборку "SQLitePCLRaw.core, версия = 1.0.0.0, культура = нейтральная, PublicKeyToken = 1488e028ca7ab535" или одна из ее зависимостей.. Игнорируется. это нормально, мне нужно добавить что-то конкретное в сам проект. - person Tlink; 12.03.2019
comment
Я имею в виду, работает ли DocFX только после добавления GenerateDocumentationFile в файл prop или DocumentationFile в .csproj? спасибо - person Tlink; 12.03.2019
comment
@Tlink Я использую сгенерированные документы XML, поэтому я не уверен, что это за ошибка .. (?) - person SushiHangover; 12.03.2019