Parâmetros de nomenclatura com Javadoc

Importante

No momento, estamos investigando o uso de associação personalizada na plataforma Xamarin. Faça esta pesquisa para informar os esforços futuros de desenvolvimento.

Este artigo explica como recuperar nomes de parâmetro em um Projeto de Associação java usando Javadoc gerado do projeto Java.

Visão geral

Ao associar uma biblioteca Java existente, alguns metadados sobre a API associada são perdidos. Em particular, os nomes de parâmetros para métodos. Os nomes dos parâmetros serão exibidos como p0, p1etc. Isso ocorre porque os arquivos Java .class não preservam os nomes de parâmetro que foram usados no código-fonte Java.

Um projeto de associação Java do Xamarin.Android poderá fornecer os nomes de parâmetro se ele tiver acesso ao HTML javadoc da biblioteca original.

Integrando o HTML Javadoc a um projeto de associação Java

A integração do HTML Javadoc a um projeto de Associação Java é um processo manual que consiste nas seguintes etapas:

1. Baixar o Javadoc para a biblioteca
2. Edite o .csproj arquivo e adicione uma <JavaDocPaths> propriedade:
3. Limpar e recompilar o projeto

Depois que isso for feito, os nomes de parâmetro java originais deverão estar presentes nas APIs associadas a um Projeto de Associação Java.

Observação

Há uma grande variação na saída javaDoc. O. A cadeia de ferramentas de associação JAR não dá suporte a cada permutação possível e, consequentemente, algum parâmetro pode não ser nomeado corretamente.

Resumo

Este artigo abordou como usar Javadoc em um Projeto de Associação Java para fornecer nomes de parâmetro de significado para APIs associadas.