Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

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.

like image 522
mck89 Avatar asked Oct 08 '10 15:10

mck89


2 Answers

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

like image 158
ashnazg Avatar answered Oct 09 '22 03:10

ashnazg


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.

like image 38
lonesomeday Avatar answered Oct 09 '22 01:10

lonesomeday