[wp-trac] [WordPress Trac] #56582: Decide how to format multi-line comments in global scope.

[WordPress Trac]

#56582: Decide how to format multi-line comments in global scope.
-------------------------+-------------------------------------
 Reporter:  costdev      |       Owner:  (none)
     Type:  enhancement  |      Status:  new
 Priority:  normal       |   Milestone:  Awaiting Review
Component:  General      |     Version:
 Severity:  normal       |  Resolution:
 Keywords:  2nd-opinion  |     Focuses:  docs, coding-standards
-------------------------+-------------------------------------

Comment (by dingo_d):

 I'm in favor of following the [https://github.com/php-fig/fig-
 standards/blob/master/proposed/phpdoc.md PSR-5] standard. They are using
 `/**` for any kind of structural element (check the [https://github.com
 /php-fig/fig-standards/blob/master/proposed/phpdoc.md#3-definitions
 documentation] for the description of a structural element definition).

 Multiline comments (starting with just one `\*`) should be used for ''non-
 essential'' explanations inside the code (like inside the function body)
 IMO.

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/56582#comment:4>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform