PHP Dokümantasyonunda ilişkisel diziyi yorumlayın.

Question

PHP uygulamamda birkaç ilişkilendirici dizi kullanıyorum ve kaynaklarımı yorumlamak için PHP dokümantasyonunu kullanıyorum. Dizilerdeki diziler için hiçbir zaman yorum yapmadım, ama şimdi bunu yapmalı ve nasıl yapmam gerektiğini bilmiyorum.

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

nasıl @var ve @param yorumlar için doğru bir şekilde bu diziyi yorum yapabilirim? Böyle bu yapabileceğini, ama bu doğru olup olmadığını bilmiyorum:

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

Ama nasıl @var kısmı için bunu yapmak?

Answer 1

Her anahtarı belgeleyemezsiniz, ancak you can tell phpDocumentor what type it is. şu anda kapsamlı olmasa,

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

Answer 2

bazı ipuçları için WordPress Inline Documentation Reference bakardım:

Böyle bir şey yapabilirdi.

bu yönergelere göre sizin bağlamda

yılında hangisi uygunsa kullanın @param veya @var veya @property, bu gibi ilişkisel dizi belgelemek olabilir: Yardımlarınız için

/** 
* @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'. 
* } 
*/