[wp-trac] [WordPress Trac] #50426: Remove @staticvar tags from core
WordPress Trac
noreply at wordpress.org
Fri Jun 19 11:54:11 UTC 2020
#50426: Remove @staticvar tags from core
----------------------------+----------------------------------------
Reporter: SergeyBiryukov | Owner: (none)
Type: defect (bug) | Status: new
Priority: normal | Milestone: 5.5
Component: General | Version:
Severity: normal | Keywords: needs-patch good-first-bug
Focuses: docs |
----------------------------+----------------------------------------
In comment:7:ticket:49446, the usage of `@staticvar` documentation tag
came up.
It's currently used in core, but was not documented in the
[https://make.wordpress.org/core/handbook/best-practices/inline-
documentation-standards/php/ PHP Documentation Standards]. It is now
mentioned with a note that it has been used in the past, but should no
longer be used.
Per discussion with @jrf, the tag was supported in phpDocumentor 1.x, but
is no longer supported in 2.x and 3.x.
Usage of static variables is considered an internal implementation detail
and has no information value for someone reading the docs. The tag is also
not listed in [https://developer.wordpress.org/reference/ WordPress Code
Reference], so removing it would not remove anything from the user-facing
documentation.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/50426>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list