Документация по API Xamarin теперь в открытом доступе

Автор оригинала: Larry O'Brien
  • Перевод
Мы рады объявить о выпуске всей документации по API Xamarin в формате Open-Source! Документация по API помогает улучшить взаимодействие с IntelliSense и является одним из лучших способов помочь разработчикам достичь своих целей.

Документация по API Xamarin


Кроме того, мы также перенесли хостинг с сайта Xamarin на docs.microsoft.com:


Новый сайт документации


Сайт docs.microsoft.com предоставляет тот же функционал презентаций, поиска, просмотра, локализации и управления версиями, который используется на платформе Microsoft .NET. Теперь вы можете выполнять фильтрацию по платформе и версии, одновременно получая быстрые и точные результаты поиска по пространствам имен, именам классов и сигнатурам членов.

image
Документация по API Xamarin теперь в Open-Source

Репозитории на GitHub


Есть отдельные репозитории Github для:


Документация по API выпускается под лицензией Creative Commons Attribution 4.0, а любой связанный исходный код под лицензией MIT. Репозиторий на Github подлежит «Microsoft Open Source Code of Conduct». Страницы документации по API Xamarin.Android являются модификациями, базирующимися на работе, созданной и совместно используемой Android Open Source Project, а также используемой в соответствии с условиями, описанными в лицензии Creative Commons Attribution 2.5.

Построено с Mono


Документация по API Xamarin построена с помощью проекта mono — набора инструментов mdoc с открытым исходным кодом. Этот набор инструментов конвертирует встроенные комментарии кода в выделенную директорию файлов документации XML. При обновлении исходной сборки добавленные/удаленные классы и члены синхронизируются с репозиторием документации. С этим инструментом вы можете аккуратно разделить инженерные и документальные проблемы.

Внесите свой вклад


Помогите, внеся свой вклад в документацию по API Xamarin или используя набор инструментов mdoc в своем собственном проекте сегодня! Отредактируйте XML-данные напрямую или используя инструмент DocWriter, чтобы избежать возможных трудностей с форматом XML.
  • +11
  • 2,7k
  • 1
Microsoft
424,31
Microsoft — мировой лидер в области ПО и ИТ-услуг
Поделиться публикацией

Комментарии 1

    0
    хм, теперь нужно писать документацию по использованию документации

    Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.

    Самое читаемое