No new line break for some at-sign@ in Javadoc comment
まだ誰も着手していません。
評価
調査の方向性
まず、提供された Javadoc の例を java-format で再現し、@InternalApi の周辺で入力とフォーマット済みの出力を比較します。Javadoc のフォーマット処理の経路を追跡して、その改行が削除される理由を特定し、その後、改行が保持されることを示す回帰テストを追加または更新します。
索引モデルが issue の本文から書いたものです。
説明
We have a string as:
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* <p> Sample code:
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* try (EchoServiceClient echoServiceClient =
* EchoServiceClient.create()) {
* EchoResponse response =
* echoServiceClient.chat();
* }
* }</pre>
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
* @InternalApi This method is internal used only. Please do not use directly.
*/
After running java-format on the above string, the Javadoc comment gets reformatted as:
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* try (EchoServiceClient echoServiceClient =
* EchoServiceClient.create()) {
* EchoResponse response =
* echoServiceClient.chat();
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails @InternalApi This method
* is internal used only. Please do not use directly.
*/
Notice the line break before @InternalApi was removed and a line break was added after @InternalApi This method. This makes the method comments hard to read.
Could you please help investigate?
Thank you!
- 主要言語
- Java
- スター
- 6.2k
- フォーク
- 936
- 平均マージ
- 6分
- マージ済み PR(30日)
- 3
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
google/google-java-format のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
google/google-java-format#1094 · コメント 1 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 15/100
google/google-java-format#1450 · リアクション 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 55/100
google/google-java-format#1439 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 62/100
google/google-java-format#1436 · コメント 2 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
google/google-java-format#1428 · コメント 3 件 ·
google/google-java-format の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
elastic/gradle-plugins#157 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
cryptomator/hub#497 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
johanhaleby/occurrent#1120 ·