google / google/google-java-format

Allow lines to start with `@foo` inside a block tag like `{@code}`

Open
#824 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
6.2k
Forks
937
Avg merge
6m
Merged PRs (30d)
3

Description

IIRC, we currently consider such an appearance of `@foo` to be an invalid tag (or, if it is a recognized one like `@return`, maybe a valid tag? or maybe never a valid tag because we're upset that the previous inline tag was never closed?). It is invalid... until Java 15, at which point https://bugs.openjdk.org/browse/JDK-8241780 saves us.

On those grounds, we don't format the Javadoc at all (which is not necessarily a great failure mode, but that's another issue).

Maybe we should just allow this, at least for cases that are not normally Javadoc tags, like `@Override`?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.