Combinaciones asociativas de comentarios en PHP Documentor

Question

Uso varias matrices asociativas en mi aplicación PHP y estoy usando documentos PHP o para comentar mis fuentes. Realmente nunca especifiqué comentarios para las matrices en una matriz, pero ahora necesito hacer eso y no sé cómo.

$array = array('id' => 'test', 'class' => 'tester', 'options' => array('option1' => 1, 'option2' => 2)) 

¿Cómo comentar esta matriz en el camino correcto para @var y @param comentarios? que podía hacer esto así, pero no sé si esto es correcto:

@param string $array['id'] 
@param string $array['class'] 
@param int $array['options']['option1'] 

Pero cómo hacer esto para la parte @var?

Answer 1

No puede documentar cada clave, pero you can tell phpDocumentor what type it is.

se podría hacer algo como esto:

/** 
* Form the array like this: 
* <code> 
* $array = array(
* 'id'  => 'foo',   // the id 
* 'class' => 'myClass',  // the class 
*); 
* 
* </code> 
* 
* @var array[string]string 
*/ 
$array; 

Answer 2

me gustaría ver en el WordPress Inline Documentation Reference para obtener algunos consejos, aunque no es actualmente integral.

Uso @param o @var o @property, lo que sea apropiado en su contexto

Según estas instrucciones, es posible documentar su matriz asociativa como esto:

/** 
* @property array $my_array { 
*  An array of parameters that customize the way the parser works. 
* 
*  @type boolean $ignore_whitespace Whether to gobble up whitespace. Default true. 
*  @type string $error_level What the error reporting level is. Default 'none'. 
*        Accepts 'none', 'low', 'high'. 
* } 
*/