current community

your communities

more stack exchange communities

Stack Exchange
tour help
stack overflow careers
Take the 2-minute tour ×
Stack Overflow is a question and answer site for professional and enthusiast programmers. It's 100% free, no registration required.
up vote 17 down vote favorite
1

which is the correct way to document class constants for phpDoc? I've read the manual but i can't find anything about them

share|improve this question

2 Answers 2

up vote 11 down vote accepted

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.

share|improve this answer
    
I don't know why it's not documented but it seems to work, thanks... –  mck89 Oct 8 '10 at 16:06
    
Better review of the @const documentation is here: stackoverflow.com/a/18446766/367456 - it also explains that no such thing exists. –  hakre Aug 12 '14 at 18:12
up vote 18 down vote

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

share|improve this answer
1  
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. –  feeela Mar 6 '13 at 9:31
    
Here's what I use: stackoverflow.com/a/24042505/244826 –  Sonny Jun 18 '14 at 12:43

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.