Asignación de nombres de parámetros con Javadoc

Importante

Estamos investigando el uso de enlaces personalizados en la plataforma Xamarin. Realice esta encuesta para informar de esfuerzos de desarrollo futuros.

En este artículo se explica cómo recuperar nombres de parámetros en un proyecto de enlace de Java mediante el uso del Javadoc generado a partir del proyecto de Java.

Información general

Al enlazar una biblioteca de Java existente, se pierden algunos metadatos sobre la API enlazada. En concreto, los nombres de los parámetros para los métodos. Los nombres de parámetros se muestran como p0, p1, etc. Esto se debe a que los archivos .class de Java no conservan los nombres de parámetro que se usaron en el código fuente de Java.

Un proyecto de enlace de Java de Xamarin.Android puede proporcionar nombres de parámetro si tiene acceso al código HTML de Javadoc de la biblioteca original.

Integración del código HTML de Javadoc en un proyecto de enlace de Java

La integración del código HTML de Javadoc en un proyecto de enlace de Java es un proceso manual que consta de los pasos siguientes:

1. Descargar Javadoc para la biblioteca
2. Edite el archivo .csproj y agregue una propiedad <JavaDocPaths>:
3. Limpiar y recompilar el proyecto

Una vez hecho esto, los nombres de parámetro originales de Java deberían estar presentes en las API enlazadas mediante un proyecto de enlace de Java.

Nota:

Existe una gran varianza en la salida de JavaDoc. La cadena de herramientas del enlace de .JAR no admite todas las permutaciones posibles y, por lo tanto, puede que algunos parámetros no tengan un nombre correcto.

Resumen

En este artículo se explica cómo usar Javadoc en un proyecto de enlace de Java para proporcionar nombres de parámetro de significado para las API enlazadas.