CODEWITHSUNDEEP
phpclassdocumentationconstantsphpdoc
mck89
mck89

Reputation: 19241

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.

Upvotes: 27

Views: 20574

Answers (3)

zxdx
zxdx

Reputation: 129

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

Upvotes: 1

lonesomeday
lonesomeday

Reputation: 237865

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.

Upvotes: 13

ashnazg
ashnazg

Reputation: 6688

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

Upvotes: 31

Related Questions