@param varname을 PHP docblock에 포함시키는 것이 여전히 적절한가요?

Question

wikipedia에 따르면 @param docblock 매개 변수의 형식은 type [$varname] description입니다. 여기서 $varname은 선택 사항입니다.

@param datatype $paramname description 
@param datatype1|datatype2 $paramname description 

가 참고 :

그래서 0.4.1의로, @param는 옵션 $의 paramName에 함께 phpdoc.de 스타일을 문서화 할 수있다 이것은 phpDocumentor 프로젝트 which states으로 백업 할 것 그것은 여전히 ​​$ paramname을 포함하는 적절한 형식입니까, 아니면 생략해야합니까?

/** 
* Have a foo! 
* 
* @param string $foo is a string 
* @param string This is another string 
* @return string 
*/ 
function haveAFoo($foo, $bar) { ... } 

Answer 1

"적절한 형식"은 $ paramname을 포함하는 것입니다. @param 행을 함수 시그니처와 일치하는 인수와 일치시킬 때 모호함을 방지합니다. "phpdoc.de 스타일"의 이전 버전과의 호환성 문제로 "선택적"으로 표시 될 가능성이 큽니다. 이 옵션 처리가 phpDocumentor2에서 계속 사용할 수 있을지는 의문입니다.