Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

No new line break for some at-sign@ in Javadoc comment

Offen
  • Stimmt etwas nicht?
#1,249 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
java
Bereich
tooling

Rechercherichtung

Beginne damit, das bereitgestellte Javadoc-Beispiel mit java-format nachzustellen und die Eingabe und die formatierte Ausgabe rund um @InternalApi zu vergleichen. Verfolge den Javadoc-Formatierungspfad, um festzustellen, warum dieser Zeilenumbruch entfernt wird, und füge anschließend einen Regressionstest hinzu oder aktualisiere einen, der zeigt, dass der Umbruch erhalten bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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!

Vorherrschende Sprache
Java
Sterne
6.2k
Forks
940
Ø Merge
5 Min.
Gemergte PRs (30 T.)
8

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus google/google-java-format

Alle Issues in google/google-java-format

Ähnliche Issues

Weitere Issues zu Java

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.