[wp-trac] [WordPress Trac] #63745: Suggestion Regarding PHPDoc Usage for $GLOBALS in WordPress Core

[WordPress Trac]

#63745: Suggestion Regarding PHPDoc Usage for $GLOBALS in WordPress Core
-------------------------+-------------------------------------------------
 Reporter:  viralsampat  |      Owner:  (none)
     Type:  enhancement  |     Status:  new
 Priority:  normal       |  Milestone:  Awaiting Review
Component:  General      |    Version:
 Severity:  normal       |   Keywords:  has-patch dev-feedback needs-
  Focuses:  docs         |  testing
-------------------------+-------------------------------------------------
 Hello Team,

 I hope you're doing well.

 While reviewing the WordPress Core files, I noticed the usage of PHPDoc
 blocks for certain global variables like **"_wp_tests_development_mode"**.
 However, I found that other global variables such as **debug** are not
 consistently documented using PHPDoc.

 I believe adding PHPDoc comments for these globals can improve code
 readability, assist with static analysis tools, and enhance overall
 documentation clarity. It might be worth considering standardizing this
 across the Core codebase.

 Thank you

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/63745>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform