PHP डॉक्यूमेंटर

Question

में टिप्पणी सहयोगी सरणी मैं अपने PHP अनुप्रयोग में कई सहयोगी सरणी का उपयोग करता हूं और मैं अपने स्रोतों पर टिप्पणी करने के लिए PHP दस्तावेज़कर्ता का उपयोग कर रहा हूं। मैंने वास्तव में किसी सरणी में सरणी के लिए टिप्पणियां निर्दिष्ट नहीं की हैं, लेकिन अब मुझे ऐसा करने की ज़रूरत है और यह नहीं पता कि कैसे।

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

मैं @var और @param टिप्पणियों के लिए सही तरीके से इस सरणी कैसे टिप्पणी कर सकता हूँ? मैं इस तरह ऐसा कर सकता है, लेकिन मैं नहीं जानता कि यदि यह सही है:

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

लेकिन यह कैसे @var भाग के लिए यह करने के लिए?

Answer 1

आप प्रत्येक कुंजी को दस्तावेज़ नहीं कर सकते, लेकिन you can tell phpDocumentor what type it is।

आप कुछ इस तरह कर सकता है:

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

Answer 2

मैं कुछ संकेत के लिए WordPress Inline Documentation Reference पर विचार करेंगे, हालांकि यह वर्तमान में व्यापक नहीं है।

@param या @var या @property उपयोग, जो भी उन दिशा निर्देशों के अनुसार अपने संदर्भ

में उचित है, तो आप इस तरह अपने साहचर्य सरणी दस्तावेज़ हो सकता है:

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