Search code examples
phpclassdocumentationconstantsphpdoc

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

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