RFR: 8364822: Comment cleanup, stale references to closeDescriptors and UNIXProcess.c [v2]
Guanqiang Han
ghan at openjdk.org
Thu Aug 7 11:27:13 UTC 2025
On Thu, 7 Aug 2025 10:25:22 GMT, Kevin Walls <kevinw at openjdk.org> wrote:
>> @fandreuz Thanks for your comment!
>>
>> You're right to point this out — I am not sure about the best placement either. I noticed that some other parts of the codebase use the same style (with the comma at the beginning of the line), so I followed that pattern here.
>>
>> That said, I'm happy to adjust it if needed. Let's leave it to @kevinjwalls to make the final call.
>
> Hi, it's a good review comment, beginning a line with a comma is not normal, we should keep the comma on the previous line.
>
> I see some javadoc that does this, but in the examples I found, there are slightly complex constructs on the previous line, so you can more easily see it's correct if comma is split, like:
>
>
> 751 * {@code (CT1 ct1, ..., CTn ctn)}
> 752 * , statically represented using varargs.
>
>
> But javadoc is also reformatted for humans, so the comma will not be split in the version people read. 8-)
> Here we should stay with the English style, and not separate the comma, thanks!
hi @kevinjwalls , thanks a lot for the detailed explanation — that makes sense! I've updated the comment accordingly. Please take another look when you have time.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/26667#discussion_r2259983441
More information about the core-libs-dev
mailing list