phpDoc class constants documentation

Question

How do I document class constants for phpDoc? I've read the manual but I can't find anything about them.

Solution 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

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).

Comments

[m13r]

using @var is the right way to do it, see github.com/phpDocumentor/fig-standards/blob/master/proposed/‌​…

[feeela]

This seems to work for phpDocumentor, but to tell Netbeans which description to show in auto-completing, one must add the @const as described in the other answer.

[hakre]

Better review of the @const documentation is here: stackoverflow.com/a/18446766/367456 - it also explains that no such thing exists.

[Leith]

Should use @var as per this answer: stackoverflow.com/a/27772200/2053165

[Wade]

Yet another terrible selected answer... Is it possible to change the selected answer? I don't recall, but you should.. --> Guys, do not use @const as it is NOT valid, NOT correct, and NOT in the docs. One day it might not work, kind of like being "deprecated" but still works until they decide to pull the plug..

[Wade]

It is @var, since @const does not exist: docs.phpdoc.org/references/phpdoc/index.html

[lonesomeday]

@Wade or you can edit, as I have done. That's how StackOverflow works. If you can find some authority for the use of @var or whatever the best solution is, please do add it to the answer.