google / google/google-java-format

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

Offen
#1,249 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Java
Sterne
6.2k
Forks
937
Ø Merge
6 Min.
Gemergte PRs (30 T.)
3

Beschreibung

We have a string as:

```java
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
*

Sample code:
*

{@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();
* }
* }

* @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:

```java
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sample code:
*
*

{@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();
* }
* }

*
* @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!

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

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