[wp-trac] [WordPress Trac] #56843: Comments in wp-login.php start with an "*" too few.
WordPress Trac
noreply at wordpress.org
Tue Oct 18 11:21:35 UTC 2022
#56843: Comments in wp-login.php start with an "*" too few.
--------------------------+------------------------------
Reporter: NekoJonez | Owner: (none)
Type: defect (bug) | Status: new
Priority: normal | Milestone: Awaiting Review
Component: Comments | Version:
Severity: minor | Resolution:
Keywords: has-patch | Focuses:
--------------------------+------------------------------
Comment (by SergeyBiryukov):
Hi there, thanks for the ticket!
I believe the current format is correct here as per the
[https://developer.wordpress.org/coding-standards/inline-documentation-
standards/php/ PHP Documentation Standards]:
* `/**` is reserved for DocBlocks, for example:
{{{
/**
* Summary.
*
* @since x.x.x
* @var type $var Description.
*/
}}}
* `/*` is for regular [https://developer.wordpress.org/coding-standards
/inline-documentation-standards/php/#5-2-multi-line-comments multi-line
comments]:
{{{
/*
* This is a comment that is long enough to warrant being stretched over
* the span of multiple lines. You'll notice this follows basically
* the same format as the PHPDoc wrapping and comment block style.
*/
}}}
--
Ticket URL: <https://core.trac.wordpress.org/ticket/56843#comment:2>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list