php - struttura - tag semantici html5




Qual รจ il modo corretto di scrivere PHPDocs per le costanti? (4)

Io uso Netbeans. Analizzerà phpDoc per le costanti globali e di classe quando viene utilizzato questo formato:

/** @const Global constant description */
define('MY_CONST', 10);

class MyClass
{
    /** @const Class constant description */
    const MY_CONST = 10;
}

Ho questo codice:

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

Non penso che l'uso di @var sia corretto per una costante e non vedo alcun tag @constant PHPDoc. Qual è il modo corretto per farlo?



Per inserirli in phpDoc, usa:

@const THING

Costrutto usuale:

@const[ant] label [description]

PHP-FIG suggerisce di utilizzare @var per le costanti.

7.22. @var

È possibile utilizzare il tag @var per documentare il "Tipo" dei seguenti "Elementi strutturali":

  • Costanti, sia di classe che di portata globale
  • Proprietà
  • Variabili, ambito globale e locale

Sintassi

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





phpdoc