Die Xamarin-API-Dokumentation ist jetzt öffentlich verfügbar

Wir freuen uns, die Veröffentlichung aller Xamarin API-Dokumentationen im Open-Source-Format bekannt zu geben! Die API-Dokumentation verbessert die Interaktion mit IntelliSense und ist eine der besten Möglichkeiten, um Entwicklern beim Erreichen ihrer Ziele zu helfen.

Xamarin API-Dokumentation


Darüber hinaus haben wir das Hosting von der Xamarin-Website auf docs.microsoft.com verschoben:


Neue Dokumentationsseite


Die Website docs.microsoft.com bietet dieselben Funktionen für Präsentation, Suche, Durchsuchen, Lokalisierung und Versionskontrolle wie auf der Microsoft .NET-Plattform. Jetzt können Sie nach Plattform und Version filtern und gleichzeitig schnelle und genaue Suchergebnisse nach Namespaces, Klassennamen und Mitgliedersignaturen erhalten.

Bild
Die Xamarin-API-Dokumentation ist jetzt Open Source

GitHub-Repositorys


Es gibt separate Github-Repositorys für:


Die API-Dokumentation wird unter der Creative Commons Attribution 4.0-Lizenz veröffentlicht , und der zugehörige Quellcode wird unter der MIT-Lizenz lizenziert . Das Repository auf Github unterliegt dem " Microsoft Open Source Code of Conduct ". Die Dokumentationsseiten der Xamarin.Android-API sind Änderungen, die auf Arbeiten basieren, die vom Android Open Source-Projekt erstellt und freigegeben wurden , und die auch gemäß den in der Creative Commons Attribution 2.5-Lizenz beschriebenen Bedingungen verwendet werden.

Gebaut mit Mono


Die Xamarin-API-Dokumentation wird mit dem Mono-Projekt erstellt, einem Open-Source- MDOC- Toolkit. Dieses Toolkit konvertiert eingebettete Codekommentare in ein dediziertes Verzeichnis von XML-Dokumentationsdateien. Beim Aktualisieren der ursprünglichen Assembly werden die hinzugefügten / entfernten Klassen und Mitglieder mit dem Dokumentationsrepository synchronisiert. Mit diesem Tool können Sie technische und dokumentarische Probleme sauber trennen.

Machen Sie Ihren Beitrag


Helfen Sie mit, indem Sie zur Xamarin-API-Dokumentation beitragen oder das mdoc-Toolkit noch heute in Ihrem eigenen Projekt verwenden! Bearbeiten Sie die XML-Daten direkt oder mit dem DocWriter- Tool, um mögliche Probleme mit dem XML-Format zu vermeiden.

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


All Articles