[wp-meta] [Making WordPress.org] #3134: WordPress.tv: Add @param and @global keywords for some variables

Making WordPress.org noreply at wordpress.org
Mon Sep 25 05:18:44 UTC 2017


#3134: WordPress.tv: Add @param and @global keywords for some variables
-------------------------------------+------------------
 Reporter:  rushabh4486              |       Owner:
     Type:  defect                   |      Status:  new
 Priority:  normal                   |   Milestone:
Component:  WordPress.tv             |  Resolution:
 Keywords:  has-patch needs-refresh  |
-------------------------------------+------------------

Comment (by rushabh4486):

 Replying to [comment:8 SergeyBiryukov]:
 > Hi @rushabh4486, welcome to WordPress Meta Trac! Thanks for the patch.
 >
 > Per WordPress' [https://make.wordpress.org/core/handbook/best-practices
 /inline-documentation-standards/php/ PHP Documentation Standards],
 `@global` tags are used to document globals in functions or methods.
 What's the benefit of adding `@global` tags right next to the global
 declarations in theme templates? Seems redundant, and none of the bundled
 themes do that.



 What about @param tag?
   @SergeyBiryukov

--
Ticket URL: <https://meta.trac.wordpress.org/ticket/3134#comment:9>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org


More information about the wp-meta mailing list