Xamarin-API-Dokumente: Open Sourced und jetzt verfügbar

Heute freuen wir uns, die Veröffentlichung aller Xamarin API-Dokumentationen als Open Source bekannt zu geben! Die API-Dokumentation verbessert die IntelliSense-Erfahrung und ist gleichzeitig eine der besten Möglichkeiten, Entwicklern beim Erreichen ihrer Ziele zu helfen.


Xamarin API-Dokumente


Darüber hinaus haben wir das Hosting von Folgendem von ihrem alten Xamarin-Zuhause auf docs.microsoft.com verschoben:



Neue Dokumentationsseite


Die Website docs.microsoft.com bietet dieselbe Präsentations-, Such-, Such-, Lokalisierungs- und Versionserfahrung wie die .NET-Plattform von Microsoft. Jetzt können Sie nach Plattform und Version filtern und gleichzeitig schnelle und genaue Suchergebnisse für Namespaces, Klassennamen und Mitgliedersignaturen erhalten.


Screenshot mit Xamarin.Forms-API-Dokumenten auf docs.microsoft.com
Xamarin API Docs jetzt Open Source

Github rep


Es gibt separate Github-Repos für:



Die API-Dokumentation wird unter der Creative Commons Attribution 4.0-Lizenz und allen zugehörigen Quellcodes unter der MIT-Lizenz veröffentlicht . Die Github-Repos unterliegen dem Open Source-Verhaltenskodex von Microsoft . Xamarin.Android API-Dokumentationsseiten sind Änderungen, die auf Arbeiten basieren, die vom Android Open Source-Projekt erstellt und freigegeben wurden und gemäß den in der Creative Commons 2.5 Attribution License beschriebenen Bedingungen verwendet werden.


Gebaut mit Mono


Die Xamarin-API-Dokumentation basiert auf der Open-Source- MDOC- Toolchain des Mono-Projekts. Diese Toolchain konvertiert Inline-Codekommentare in ein dediziertes Verzeichnis von XML-Dokumentationsdateien. Wenn Sie Ihre Quellassembly aktualisieren, werden hinzugefügte / entfernte Klassen und Mitglieder mit dem Dokumentations-Repo synchronisiert. Mit diesem Tool können Sie Engineering- und Dokumentationsprobleme sauber trennen.


Tragen Sie bei


Helfen Sie mit, einen Beitrag zu den Xamarin-API-Dokumenten zu leisten, oder verwenden Sie die mdoc-Toolchain noch heute in Ihrem eigenen Projekt! Bearbeiten Sie das XML direkt oder verwenden Sie das DocWriter- Tool, um die Komplexität des XML-Formats zu vermeiden.

Source: https://habr.com/ru/post/de453532/


All Articles