Commentare arrays associativo in PHP Documentor

Io uso diversi arrays associativi nella mia applicazione PHP e sto usando il documentatore PHP per commentare le mie fonti. Non ho mai veramente specificato i commenti per gli arrays in un arrays, ma ora ho bisogno di farlo e non so come.

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

Come commento questa matrix nel modo corretto per i commenti @var e @param ? Potrei farlo in questo modo, ma non so se è corretto:

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

Ma come farlo per la parte @var ?

Non è ansible documentare each chiave, ma si può dire a phpDocumentor che tipo è .

Potresti fare qualcosa del genere:

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

Vorrei dare un'occhiata alla documentazione in linea di WordPress per alcuni suggerimenti, anche se non è al momento completa.

Utilizza @param o @var o @property, a seconda di quale sia appropriato nel tuo context

Secondo queste linee guida, potresti documentare il tuo arrays associativo in questo modo:

 /** * @property arrays $my_arrays { * An arrays 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'. * } */