2012-03-03 4 views
0

phpdocumentor 클래스의 배열 속성을 올바르게 문서화하는 방법을 찾으려고합니다.phpdocumentor 클래스의 배열 속성을 올바르게 문서화하려면 어떻게해야합니까?

예는 :

<?php 
class foo { 
    /** 
    * This holds something important 
    * @var string 
    */ 
    protected $junk; 
    /** 
    * This holds an important array of strings 
    * @var ??????? 
    */ 
    protected $stuff = array(); 
    // ... 
} 
?> 

나는 배열 속성에 대해하는 PHPDoc 설명서에서 아무것도 찾을 수 없습니다.

+3

'* @var string [] '을 (를) 사용해 보셨습니까? 또한 참조하십시오 : 개체 배열에 대한 PHPDoc 형식 힌팅? (http://stackoverflow.com/q/778564/367456) – hakre

+0

'@var array' ?? –

+0

netbeans에서는 @var 문자열 []을 (를) 허용하는 것으로 보입니다. 감사합니다. –

답변

2

/** @var array */protected $stuff에 대한 올바른 구문입니다. @var에 대한 phpDocumentor 또는 man 페이지는 "데이터 유형은 유효한 PHP 유형 (int, string, bool 등)"이어야하며 "array"는 유효한 PHP 유형입니다.

일부 IDE는 /** @var ElementType[] */을 인식하기 시작하여 "이 요소는 모두 ElementType 유형의 배열입니다"라고 나타 내기 시작했습니다. 이 구문은 phpDocumentor의 다음 버전에서 사용할 수 있습니다.

관련 문제