Chú thích mảng kết hợp trong PHP Documentor

Question

Tôi sử dụng một số mảng kết hợp trong ứng dụng PHP của mình và tôi đang sử dụng tài liệu PHP để nhận xét các nguồn của mình. Tôi chưa bao giờ thực sự chỉ định các chú thích cho các mảng trong một mảng, nhưng bây giờ tôi cần phải làm điều đó và không biết làm thế nào.

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

Làm cách nào để nhận xét mảng này theo cách chính xác cho @var và @param nhận xét? tôi có thể làm điều này như thế này, nhưng tôi không biết nếu điều này là đúng:

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

Nhưng làm thế nào để làm điều này cho các phần @var?

Answer 1

Bạn không thể ghi lại mỗi khóa, nhưng you can tell phpDocumentor what type it is.

Bạn có thể làm một cái gì đó như thế này:

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

Answer 2

tôi sẽ nhìn vào WordPress Inline Documentation Reference cho một số gợi ý, mặc dù nó không phải là hiện toàn diện.

Sử dụng @ param hoặc @var hoặc @property, nào là thích hợp trong bối cảnh của bạn

Theo những hướng dẫn, bạn có thể ghi lại mảng kết hợp của bạn như thế này:

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