I have this code: <pre class="prettyprint"><code>/** * Days to parse * @var int */ const DAYS_TO_PARSE = 10; ... </code></pre> I don't think that using <code>@var</code> is correct for a constant and I don't see any <code>@constant</code> PHPDoc tag. What is the correct way to do this?

The PHP-FIG suggests using <code>@var</code> for constants. <blockquote> 7.22. <code>@var</code> You may use the <code>@var</code> tag to document the "Type" of the following "Structural Elements": <ul> <li>Constants, both class and global scope</li> <li>Properties</li> <li>Variables, both global and local scope</li> </ul> Syntax <code>@var ["Type"] [element_name] [<description>]</code> </blockquote>

What is the correct way to write PHPDocs for constants?

Tags:

php

phpdoc

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?

684

asked Jul 15 '11 11:07

Elzo Valugi

1 Answers

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