'phpDoc class constants documentation
How do I document class constants for phpDoc? I've read the manual but I can't find anything about them.
Solution 1:[1]
I'm fairly sure that you can use @const, though I can't find any English documentation. There's a German example here. It shows define statements rather than class constants, but IIRC the syntax is the same.
Nine years later, an edit...
It is clear now that the above is bad advice as @const has not appeared in the docs and it seems it will not.
Using @var seems to work, though I cannot see it explicitly specified anywhere.
Solution 2:[2]
Constants only need a docblock that contains the description. No specific tag is necessary. The code parser itself identifies constants and displays them as such in the generated documentation (here's an example).
Solution 3:[3]
The full list of all PHPDoc 3 tags: Tag reference
The manual says the following:
@var
You may use the @var tag to document the Type of the following Structural Elements:
- Constants, both class and global scope
- Properties
- Variables, both global and local scope
Sources
This article follows the attribution requirements of Stack Overflow and is licensed under CC BY-SA 3.0.
Source: Stack Overflow
| Solution | Source |
|---|---|
| Solution 1 | |
| Solution 2 | Gajus |
| Solution 3 | zxdx |