Javadoc でパラメーターに名前を付ける
重要
現在、Xamarin プラットフォームでのカスタム バインディングの使用を調査しています。 今後の開発作業の発展のために、このアンケートにご回答ください。
この記事では、Java プロジェクトから生成された Javadoc を使用して Java バインド プロジェクト内のパラメーター名を回復する方法について説明します。
概要
既存の Java ライブラリをバインドする場合、バインドされた API に関するメタデータの一部は失われます。 具体的には、メソッドのパラメーターの名前です。
パラメーター名は、p0
、p1
などとして表示されます。これは、Java の .class
ファイルでは、Java ソース コードで使用されたパラメーター名が保持されないためです。
Xamarin.Android Java バインド プロジェクトでは、元のライブラリから Javadoc HTML にアクセスできる場合は、パラメーター名を指定できます。
Java バインド プロジェクトへの Javadoc HTML の統合
Javadoc HTML を Java バインド プロジェクトに統合するには、次の手順で構成される手動のプロセスを実行します。
- ライブラリ用の Javadoc をダウンロードします
.csproj
ファイルを編集し、<JavaDocPaths>
プロパティを追加します- プロジェクトをクリーンアップしてリビルドします
この処理が完了したら、Java バインド プロジェクトによってバインドされた API に元の Java パラメーター名が存在するはずです。
Note
JavaDoc の出力には、非常に大きなバリエーションがあります。 .JAR バインディング ツールチェーンは、考えられるすべての変形をサポートしているわけではないため、一部のパラメーターに適切な名前が付けられない場合があります。
まとめ
この記事では、Java バインド プロジェクトで Javadoc を使用して、バインドされた API に対して意味のあるパラメーター名を指定する方法について説明しました。