[wp-trac] [WordPress Trac] #52997: Coding Standards: Multi-Line Code Comment Format Used In Place Of Single-Line Format.

[WordPress Trac]

#52997: Coding Standards:  Multi-Line Code Comment Format Used In Place Of Single-
Line Format.
-----------------------------+-------------------------------------
 Reporter:  rkradadiya       |       Owner:  (none)
     Type:  feature request  |      Status:  closed
 Priority:  normal           |   Milestone:
Component:  Users            |     Version:  5.7
 Severity:  normal           |  Resolution:  invalid
 Keywords:  has-screenshots  |     Focuses:  docs, coding-standards
-----------------------------+-------------------------------------
Changes (by SergeyBiryukov):

 * status:  assigned => closed
 * resolution:   => invalid
 * component:  General => Users
 * milestone:  Awaiting Review =>


Comment:

 Hi there, thanks for the ticket!

 {{{
 /** This action is documented in path/to/filename.php */
 }}}
 This comment format is used for documenting
 [https://make.wordpress.org/core/handbook/best-practices/inline-
 documentation-standards/php/#4-1-duplicate-hooks duplicate hooks] as per
 the documentation standards. It's widely used in other core files and is
 correct as is.

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