Nommage des paramètres avec Javadoc

Important

Nous étudions actuellement l’utilisation de la liaison personnalisée sur la plateforme Xamarin. S’il vous plaît prendre cette enquête pour informer les efforts de développement futurs.

Cet article explique comment récupérer des noms de paramètres dans un projet de liaison Java à l’aide de Javadoc généré à partir du projet Java.

Vue d’ensemble

Lors de la liaison d’une bibliothèque Java existante, certaines métadonnées relatives à l’API liée sont perdues. En particulier les noms des paramètres des méthodes. Les noms de paramètres s’affichent sous la forme p0, p1, etc. En effet, les fichiers Java .class ne conservent pas les noms de paramètres qui ont été utilisés dans le code source Java.

Un projet de liaison Java Xamarin.Android peut fournir les noms de paramètres s’il a accès au code HTML Javadoc à partir de la bibliothèque d’origine.

Intégration du code HTML Javadoc à un projet de liaison Java

L’intégration du code HTML Javadoc à un projet de liaison Java est un processus manuel comprenant les étapes suivantes :

1. Télécharger javadoc pour la bibliothèque
2. Modifiez le .csproj fichier et ajoutez une <JavaDocPaths> propriété :
3. Nettoyer et reconstruire le projet

Une fois cette opération effectuée, les noms de paramètres Java d’origine doivent être présents dans les API liées par un projet de liaison Java.

Notes

Il existe une grande variation dans la sortie JavaDoc. Lla. La chaîne d’outils de liaison JAR ne prend pas en charge toutes les permutations possibles et, par conséquent, certains paramètres peuvent ne pas être correctement nommés.

Résumé

Cet article explique comment utiliser Javadoc dans un projet de liaison Java pour fournir des noms de paramètres de signification pour les API liées.