당신이 MVC

Question

에서보기를 반환하는 경우 PHP의 @return를 문서화하는 방법

은 그래서 내 몇 가지 방법 안에 내 컨트롤러에서 나는이 같은 뷰를 반환 할 것을 가정 해 봅시다 이 메소드가 리턴하는 것을 문서화하려고합니다. 이 메서드가 뷰를 반환하는지 문서화하는 방법을 모르겠습니다. 그것은 자원입니까? 혼합인가?

유효합니까? :

@return resource 

그리고 당신의 방법이 다른 페이지로 리다이렉트를 반환하는 것을 어떻게 문서화합니까?

Answer 1

귀하의 docblock은 IDE에서 입력 힌팅을 제공하고 쉽게 읽을 수있게 해줍니다. 그건 당신이 반환하는지의 경우 절대적으로, @return 자원을 수행 할 수 있습니다,하지만 당신은 단지 더 많은 주석을 포함 할 수도에 대한 프레임 워크에서보다 구체적인 클래스가 있다면

/** 
* This function returns a view which then redirects the user to another page 
* 
* @param string $model The model we looked at 
* @return resource The page to redirect to 
*/ 
function foo($model){ 
    return $this->render('home', [ 
    'model' => $model, 
    ]); 
} 

무엇을 $ this-의 실제 반환 > 렌더링은 그렇지만 아마도 이것을 포함해야하지만, $ this-> render가 페이지를 리다이렉트한다고 말한다면 실제로는이 함수가 호출되지 않기 때문에이 함수 내부로 반환 할 이유가 없다. void 함수 (또는 실패 할 경우를 대비하여 boolean을 반환 할 수 있습니다.)