WordPress.org

Make WordPress Core

Opened 8 months ago

Closed 8 months ago

#52997 closed feature request (invalid)

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

Reported by: rkradadiya Owned by:
Milestone: Priority: normal
Severity: normal Version: 5.7
Component: Users Keywords: has-screenshots
Focuses: docs, coding-standards Cc:

Description

Hello,

WordPress has a comment structure.

But developers have used a multi-line comment structure in a single-line comment in the below file.

wp-admin/user-new.php

Please use single line comment instead of a multiline.

Thanks,
Rajesh

Attachments (1)

Screenshot 2021-04-08 at 9.11.54 AM.png (24.0 KB) - added by rkradadiya 8 months ago.

Download all attachments as: .zip

Change History (2)

#1 @SergeyBiryukov
8 months ago

  • Component changed from General to Users
  • Milestone Awaiting Review deleted
  • Resolution set to invalid
  • Status changed from assigned to closed

Hi there, thanks for the ticket!

/** This action is documented in path/to/filename.php */

This comment format is used for documenting duplicate hooks as per the documentation standards. It's widely used in other core files and is correct as is.

Note: See TracTickets for help on using tickets.