[wp-trac] [WordPress Trac] #63795: Suggestion: Standardizing PHPDoc Comments for Global Variables in Core Theme Files

[WordPress Trac]

#63795: Suggestion: Standardizing PHPDoc Comments for Global Variables in Core
Theme Files
-------------------------+-------------------------------------------------
 Reporter:  viralsampat  |      Owner:  (none)
     Type:  defect       |     Status:  new
  (bug)                  |
 Priority:  normal       |  Milestone:  Awaiting Review
Component:  Bundled      |    Version:
  Theme                  |   Keywords:  2nd-opinion has-patch dev-feedback
 Severity:  normal       |  needs-testing
  Focuses:  docs         |
-------------------------+-------------------------------------------------
 Hello Team,

 While reviewing the core theme files, I noticed that PHPDoc blocks are
 used for documenting some global variables, which is great. However, I
 also observed that several other global variables lack consistent PHPDoc
 documentation.

 To improve code readability, support static analysis tools, and maintain
 clear documentation standards, it may be beneficial to standardize PHPDoc
 comments for all global variables throughout the Core codebase.

 Just a suggestion that could contribute to better maintainability and
 developer experience.

 Thank you!

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