¿Cuál es la forma correcta de documentar las constantes de PHP (definir) con phpDocumentor

Question

¿Cómo debemos documentar (con phpDocumentor) las constantes definidas con define() en PHP?

no he encontrado nada en la documentación, pero no encontró el siguiente ejemplo (que no veo su uso) en el sample2.php:

/**#@+ 
* Constants 
*/ 
/** 
* first constant 
*/ 
define('testing', 6); 
/** 
* second constant 
*/ 
define('anotherconstant', strlen('hello')); 

alguien me puede decir cuál es la mejor manera de documentar las constantes en PHP con phpDocumentor?

Answer 1

En general, las declaraciones de definición solo se comentan con un texto descriptivo, por lo que básicamente se trata de cómo lo comentas.

Para obtener más información sobre la etiqueta de plantilla DocBlock, /**#@+, consulte the manual page.

Answer 2

Usted tiene en phpDoc.org the elements that can be documented.

También tiene an example of documenting a define() (la segunda parte del código y los párrafos que lo rodean).

Answer 3

/** 
*@const 
*/ 
const testing=6; 
const anotherconstant=strlen('hello'); 

Prueba esto se verá como constante