Search code examples
phpphpdoc

What is the correct way to write PHPDocs for constants?


I have this code:

/**
 * Days to parse
 * @var int
 */
const DAYS_TO_PARSE = 10;
...

I don't think that using @var is correct for a constant and I don't see any @constant PHPDoc tag. What is the correct way to do this?


Solution

  • To get them into phpDoc, use:

    @const THING
    

    Usual construct:

    @const[ant] label [description]