Comment Error in wp-login.php

[alkesh7]

Hello WordPress Team,

I have seen that WordPress have issue in the comment structure.

WordPress follow a comment structure. See the Comment Standard link: ​https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments

In the WordPress 5.9 Release Candidate Version. There is a Comment structure issue in file "wp-login.php" in root folder. See the issue in the below screenshot.
​https://prnt.sc/263q9qs

Kindly take a look on my request and fix it.

Thank you!

[audrasjb]

Hello and welcome back to Trac!
As we entered release candidate cycle for 5.9, let's address this in 6.0.

[Presskopp]

Oh, we have this in many many places!

[peterwilsoncc]

@Presskopp Yes, it's in several places in core. I found it in 49 files but some of those were third party libraries.

For the purposes of this ticket, let's focus on wp-login.php and any further fixes can go on the generic coding standards fixes ticket #54728.

[peterwilsoncc]

In 52945:

Registration/Login: Coding standards fixes for wp-login.php.

Props alkesh7, Presskopp, audrasjb.
Fixes #54746.
See #54728.

[SergeyBiryukov]

I think comments like "Main" have some benefit, as they denote various parts of the file, in this case separating function declarations from the main part.

Instead of removing them, I think we can convert them to the multi-line format per the documentation standards:

/*
 * Main.
 */

[peterwilsoncc]

Replying to SergeyBiryukov:

I think comments like "Main" have some benefit, as they denote various parts of the file, in this case separating function declarations from the main part.

With the additional context they do, on it's own the word main is meaningless.

Instead of removing them, I think we can convert them to the multi-line format per the documentation standards:

/*
 * Main.
 */

The point is to meet the coding standards by avoiding single line comments of that format. Given that the additional context is needed for the comment to make sense, I think it best revised as a multi-line comment anyway.

[SergeyBiryukov]

In 53313:

Docs: Further clarify a comment for the main part of wp-login.php.

Follow-up to [52945].

Fixes #54746.