Benennen von Parametern mit Javadoc

Wichtig

Wir untersuchen derzeit die Nutzung benutzerdefinierter Bindungen auf der Xamarin-Plattform. Nehmen Sie an dieser Umfrage teil, um zukünftige Entwicklungsarbeiten zu unterstützen.

In diesem Artikel wird erläutert, wie Parameternamen in einem Java-Bindungsprojekt mithilfe von JavaDoc wieder hergestellt werden, die vom Java-Projekt generiert wurden.

Übersicht

Wenn eine vorhandene Java-Bibliothek gebunden wird, gehen einige Metadaten zur gebundenen API verloren. Dies gilt besonders für die Namen von Parametern zu Methoden. Parameternamen werden als p0, p1 usw. angezeigt. Dies liegt daran, dass die .class-Dateien in Java die Parameternamen nicht beibehalten, die im Java-Quellcode verwendet wurden.

Eine Java-Bindungsprojekt in Xamarin.Android kann die Parameternamen bereitstellen, wenn es Zugriff auf die Javadoc-HTML über die ursprüngliche Bibliothek hat.

Integrieren der Javadoc-HTML in ein Java-Bindungsprojekt

Das Integrieren der Javadoc-HTML in ein Java-Bindungsprojekt ist ein manueller Vorgang, der aus folgenden Schritten besteht:

1. Herunterladen der Javadoc-Datei für die Bibliothek
2. Bearbeiten der Datei .csproj und Hinzufügen einer <JavaDocPaths>-Eigenschaft
3. Bereinigen und Neuerstellung des Projekts

Sobald diese Schritte abgeschlossen sind, sollten die ursprünglichen Java-Parameternamen in den durch das Java-Bindungsprojekt gebundenen APIs vorhanden sein.

Hinweis

Die JavaDoc-Ausgabe kann sehr unterschiedlich ausfallen. Die JAR-Bindungstoolkette unterstützt nicht jede mögliche Permutation und deshalb auch einige Parameter nicht, die nicht ordnungsgemäß benannt wurden.

Zusammenfassung

In diesem Artikel wurde erläutert, wie JavaDoc in einem Java-Bindungsprojekt verwendet wird, um sinnvolle Parameternamen für gebundene APIs bereitzustellen.