<i18n dev> RFR: 8331879: Clean up non-standard use of /// comments in `java.base`

Jonathan Gibbons jjg at openjdk.org
Tue May 28 20:25:02 UTC 2024


On Tue, 28 May 2024 20:01:46 GMT, Alan Bateman <alanb at openjdk.org> wrote:

> > OK. I was just trying to honor the apparent intent to make the comment stand out more than just a plain `//` comment, but I have no strong feelings against reducing `///` to `//`
> 
> In this case I would reduce it to '//' but others will have different opinions of course.

What about changing `///` to `//---` to give slightly more prominence to these comments, over plain old `//` comments.
The dashes give a small sense of a horizontal rule, to delimit sections of code.

(FWIW, I have locally edited `//|` to `//` and such comments do not stand out beside existing use of `//`.)

-------------

PR Comment: https://git.openjdk.org/jdk/pull/19130#issuecomment-2136042843


More information about the i18n-dev mailing list