@return self, this 또는 현재 클래스를 사용해야합니까?

Question

현재 개체를 반환하는 메서드가 있는데 어떻게 문서화합니까?

/** 
* set something 
* 
* @return this 
*/ 
public function setSomething(){ 
      // ... 
    return $this; 
} 

아니면 내가 @return self 또는 @return Current_Class_Name을해야합니까?

Answer 1

@return Current_Class_Name 확실히 작동하며 내가 선호하는 것입니다.

@return self 일부 프로그램에서도 제대로 작동 할 수 있습니다.

@return this은 typename이 아니기 때문에 좋지 않습니다.

Answer 2

/** 
* set something 
* 
* @return self 
*/ 
public function setSomething(){ 
      // ... 
    return $this; 
} 

당신은 @param 나 @return 등 "자기"유형을 사용할 수 있습니다

..

하는 PHPDoc은 객체 자체를 참조하는 '자기'.. 권장

출처 : http://www.phpdoc.org/docs/latest/references/phpdoc/types.html

Answer 3

현재 PHP Standards Recommendation (PSR)이 초안에 있습니다. (PSR-5) that proposes@return $이이 사용되어 동일한 인스턴스가 반환되었음을 나타냅니다.

$ this,이 유형이 적용되는 요소는 지정된 컨텍스트에서 현재 클래스와 동일한 정확한 인스턴스입니다. 이와 같은 유형은 정적 클래스의보다 엄격한 버전이므로 반환되는 인스턴스는 동일한 클래스 일뿐만 아니라 동일한 인스턴스 여야합니다.

이 유형은 종종 유창한 인터페이스 디자인 패턴을 구현하는 메소드의 반환 값으로 사용됩니다.

이 표기법은 현재 PhpStorm 및 Netbeans와 같은 널리 사용되는 IDE에서 사용됩니다.

Answer 4

이 질문은 꽤 오래되었지만 모두에게 공유하고 싶습니다. 내가 NetBeans8.1 사용자를위한 AT LEAST 말

/** 
* Method that returns $this instance (using late state binding) 
* @return static 
*/ 
public function iWillReturnMyself () { 
    return $this; 
} 

: 넷빈즈 8.1를 사용하는 사람을위한

AT LEAST은 ..이 표기법은 잘 IDE에서 작동하도록 코드 자동 완성한다 하지만 은 이전 버전 및/또는 다른 IDE에서을 사용할 수도 있습니다.