PHP에서 허용되는 배열 매개 변수 값을 문서화하는 방법

Question

종종 배열을 생성자 매개 변수로 전달하고 있습니다. 허용되는 값은 어떻게 문서화해야합니까? 필자는 몇 가지 스타일을 시도했지만 phpdoc에서 약간의 엉망이 생겼다.

Answer 1

가 정말 해시 배열을 문서화에 대한 "공식적인"하는 PHPDoc 방법은 없지만 여기에서 방법 :

/** 
* @param array $options hash of standard options for this class: 
* int id the id of whatever object 
* string name name of whoever it is 
* array sub_option hash of sub options: 
*  int num number description for this index 
* bool is_good should we do this or not? 
*/ 
function __construct($options){ 
}