Azure / Azure/azure-functions-java-library
Incorrect Javadoc comment in HttpTrigger.java
オープン
まだ誰も着手していません。
area:java-functions
- 主要言語
- Java
- スター
- 45
- フォーク
- 49
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
The following Javadoc describes the HttpTriger route method, but the sample described is incorrect and causes a compile error.
The correct method type is HttpResponseMessage, not HttpResponseMessage<String>.
@FunctionName("routeTest")
public HttpResponseMessage<String> routeTest(
@HttpTrigger(name = "req",
methods = {HttpMethod.GET},
authLevel = AuthorizationLevel.ANONYMOUS,
route = "products/{category:alpha}/{id:int}")
HttpRequestMessage<Optional<String>> request,
@BindingName("category") String category,
@BindingName("id") int id,
final ExecutionContext context
) {
....
context.getLogger().info("We have " + category + " with id " + id);
....
}
This Javadoc is probably auto-generated from the following link.
Please fix it.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
src/main/java/com/microsoft/azure/functions/annotation/HttpTrigger.java を 140 行目付近で開き、Javadoc の例とリンク先のルートドキュメントを比較します。例の戻り値の型を、記載されているメソッドの型と一致するように修正し、その後、Javadoc の例に報告されたコンパイルエラーが含まれなくなったことを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 45/100