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.

using @var is the right way to do it, see github.com/phpDocumentor/fig-standards/blob/master/proposed/… — m13r
– m13r, Commented Apr 11, 2017 at 5:42
Does this answer your question? What is the correct way to write PHPDocs for constants? — Melebius
– Melebius, Commented Aug 30, 2022 at 8:41

Gajus · Accepted Answer · 2014-08-01 14:12:18Z

31

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

edited Aug 1, 2014 at 14:12

Gajus

74.6k81 gold badges301 silver badges479 bronze badges

answered Oct 8, 2010 at 15:59

ashnazg

6,7282 gold badges34 silver badges40 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

feeela Over a year ago

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.

CyberPunkCodes Over a year ago

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

lonesomeday · Accepted Answer · 2019-07-22 16:07:21Z

13

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.

edited Jul 22, 2019 at 16:07

answered Oct 8, 2010 at 15:47

lonesomeday

239k54 gold badges330 silver badges329 bronze badges

4 Comments

hakre Over a year ago

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

Leith Over a year ago

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

CyberPunkCodes Over a year ago

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

lonesomeday Over a year ago

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

zxdx · Accepted Answer · 2022-04-15 08:46:52Z

1

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

answered Apr 15, 2022 at 8:46

zxdx

1291 silver badge4 bronze badges

Collectives™ on Stack Overflow

phpDoc class constants documentation

3 Answers 3

2 Comments

4 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related