2011-11-14 4 views
2

함수에 phpdoc를 사용할 때 항상 클래스의 인스턴스를 포함하는 인수가 있으면 생성 된 phpdoc가 주어진 클래스에 링크되도록 phpdoc에서이를 문서화 할 수있는 방법이 있습니까?phpDoc, @param 클래스 인스턴스?

와 비슷한 것 @param MyClass() $var.

문서에서 해당 정보를 찾을 수 없습니다. 사실 설명서에는 개체 (stdClass) 유형 매개 변수 인 마침표도 포함되어 있지 않습니다. 당신이 필요로하는 (

@param type [$varname] description 

이 문서 http://manual.phpdoc.org/HTMLframesConverter/default/에서보세요 :

답변

5

당신은 괄호를 제거해야하고 그것은 상자 밖으로 작동합니다 :

@param MyClass $var Parameter takes instance of MyClass 

이에 대한 공식 구문은 왼쪽의 @param을 클릭하십시오)

+0

완벽하니, 고마워요. 코드를 문서화하는 데 사용되는 소프트웨어를 만드는 개발자는 코드를 잘 문서화하지 못합니다. :) – Naatan

+2

실제로 : http://manual.phpdoc.org/HTMLframesConverter/default/에서 @param을 클릭하십시오. – halfdan

+0

내가 너무 빨리 읽고 있어야합니다, 감사합니다 :) – Naatan