phpdoc: ¿Cuál es la forma correcta de documentar una constante

Question

¿Existe una forma adecuada de documentar una constante definida usando define()? @var realmente no tiene sentido. Lo único que se me ocurre es omitir la etiqueta y simplemente escribir la descripción en el comentario de PHPdoc.

Answer 1

phpDocumentor no reconoce ni utiliza una etiqueta @const. phpDocumentor reconoce una constante cuando ve la palabra clave "definir" en el código. Sus plantillas de salida mostrarán todas las constantes en la documentación de salida, listadas como constantes. Lo único que se necesita en el docblock de la constante es una descripción, aunque se permiten muchas otras etiquetas "estándar" si sientes que las necesitas [1].

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html#procedural.define

Answer 2

Use @const.

/** 
    * @const FOO Bar 
    */ 
define('FOO', 'Bar'); 

Documentation (En este momento, los únicos documentos que puedo encontrar son en alemán.)

Answer 3

que realmente desea utilizar @type, ver el Github PHP Documentation.