What is the correct way to write PHPDocs for constants?

Question

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?

Answer 1

The PHP-FIG suggests using @var for constants.

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

Syntax

@var ["Type"] [element_name] [<description>]