Coding Standards: Single-Line Code Comment Format Used In Place Of Multi-Line Format.

[pinkalbeladiya]

Wordpress have a comment structure. In the file developer use the single line comment structure. Replace it with the wordpress comment structure.

[pinkalbeladiya]

wp-admin\includes\class-wp-media-list-table

[davidbaumwald]

@mukesh27 I actually think this is not in the Comments component, and the ticket might be titled inaccurately. It seems this ticket concerns a code comment block on line 74 in wp-admin/includes/class-wp-media-list-table.php.

@pinkalbeladiya Can you confirm this is still an issue in version 5.6? I took a look at the code comment in your screenshot, but there appears to be no formatting problems in the most recent version.

[pinkalbeladiya]

@mukesh27 Yes, This is in wordpress 5.6. See the link ​https://prnt.sc/w3053l
Replying to davidbaumwald:

@mukesh27 I actually think this is not in the Comments component, and the ticket might be titled inaccurately. It seems this ticket concerns a code comment block on line 74 in wp-admin/includes/class-wp-media-list-table.php.

@pinkalbeladiya Can you confirm this is still an issue in version 5.6? I took a look at the code comment in your screenshot, but there appears to be no formatting problems in the most recent version.

[davidbaumwald]

@pinkalbeladiya Can you describe the issue/problem with the comment? I've read the comment a few times, but I'm not seeing an issue with the formatting of it.

[pinkalbeladiya]

I think the format of comment is:
/*
*
*
*
*/

And there is used sigle line comment.

Replying to davidbaumwald:

@pinkalbeladiya Can you describe the issue/problem with the comment? I've read the comment a few times, but I'm not seeing an issue with the formatting of it.

[davidbaumwald]

@pinkalbeladiya Thanks for the additional context! I actually don't think this is an issue. Running some REGEX on the source, there are thousands of instances of the single-line comment style being used for multi-line comments. Also, there doesn't appear to be any rule in the ​PHP Coding Standards that forbids code comments in this format.

Tagging this as close for now.

[SergeyBiryukov]

Replying to davidbaumwald:

Running some REGEX on the source, there are thousands of instances of the single-line comment style being used for multi-line comments. Also, there doesn't appear to be any rule in the ​PHP Coding Standards that forbids code comments in this format.

There is a ​section in the documentation standards that clarifies which format is generally recommended.

This was previously corrected for other inline comments in core in [47122]. I think I opted to keep comments with one or two lines in single line format, and switch comments with three or more lines to the multi-line format.

It looks like this is the only instance introduced since then that's not in an external library, so we might as well fix it :)

[SergeyBiryukov]

In 50071:

Docs: Switch a comment in WP_Media_List_Table::prepare_items() to multi-line format, per the documentation standards.

Follow-up to [48417].

Props pinkalbeladiya, davidbaumwald.
Fixes #52025.