phpDoc class constants documentation

php class documentation constants phpdoc
mck89 picture mck89 · Oct 8, 2010 · Viewed 19.1k times · Source

How do I document class constants for phpDoc? I've read the manual but I can't find anything about them.

Answer

ashnazg picture ashnazg · Oct 8, 2010

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

Related questions

PhpDoc for interface and class implementing interface - difference

The question is quite simple - how should I differ phpdoc for interface and for class implementing interface? Should/Can they be the same or maybe interface documentation should be as general as possible and class implementing this interface more …

Read More
When to use self over $this?

In PHP 5, what is the difference between using self and $this? When is each appropriate?

Read More
PHP Fatal error: Using $this when not in object context

I've got a problem: I'm writing a new WebApp without a Framework. In my index.php I'm using: require_once('load.php'); And in load.php I'm using require_once('class.php'); to load my class.php. In my class.…

Read More