google / google/google-java-format

Comments starting with /// should not be reformatted as // /

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

Description

I'm toying (more "for fun") with ~~https://openjdk.org/jeps/330~~ something in https://github.com/enola-dev/enola/issues/971:

I am using https://www.jbang.dev, but Im not sure if this issue specific to that tool or really could be considered more generically:

As per https://www.jbang.dev/documentation/guide/latest/faq.html, and (apparently) partly inspired by https://golangcookbook.com/chapters/running/shebang/ in Go, given that JEP 330 "shebang" headers are still a bit of a PITA (see also related #1214), I'm starting a Java file with `///usr/bin/env jbang "$0" "$@" ; exit $?`

google-java-format reformats `///usr/bin/env jbang "$0" "$@" ; exit $?` to `/// usr/bin/env jbang "$0" "$@" ; exit $?` (note the added space), which breaks the magic.

Unfortunately, as per https://github.com/google/google-java-format/wiki/FAQ#why-cant-i-use-magic-comments-to-disable-formatting-for-certain-sections-of-code, it does not seem to be easily possible to suppress formatting that first line.

The only choice seems to be not to use google-java-format for such "script" like Java files (shame), or not to use that header in them.

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.