하는 PHPDoc 매개 변수없이 또는 반환 값

내가 다음 클래스 스텁을 말한다. 올바른 phpDoc 블록은 무엇입니까?하는 PHPDoc 매개 변수없이 또는 반환 값

public function beCourteous() { 
    // No docblock 
    echo 'Salutations, dear ' . $this->guestsName; 
} 

/** 
* 
*/ 
public function beCourteous() { 
    // One blank line 
    echo 'Salutations, dear ' . $this->guestsName; 
} 

/** 
*/ 
public function beCourteous() { 
    // No blank lines 
    echo 'Salutations, dear ' . $this->guestsName; 
}

출처

2014-10-23 Joe

매개 변수를 허용하지 않고 값을 반환하는 함수는 문서 주석에 @param 또는 @return이 없어야합니다. (관련, 정확히 속는 사람을) PHPDoc: @return void necessary?

그리고 여기 : 그러나, 당신은 (해야하고) 여전히 설명

/** 
* Echos a salutation to <code>$this->guestsName</code> 
*/ 
public function beCourteous() { 
    echo 'Salutations, dear ' . $this->guestsName; 
}

여기를 참조하십시오 포함 할 수있는 문자열을 반환 http://en.wikipedia.org/wiki/PHPDoc

출처

2014-10-23 17:57:02 chiliNUT

이것은 사실이고, 내가 OP에서 언급하는 것을 잊었습니다. 이 예에서는 설명이 포함되어 있지 않다고 가정 해 보겠습니다. docblock의 내용은 비어있을 것이다. 그걸 처리하는 정상적인 방법은 뭐니? – Joe

'@return void'를 명시 적으로 표시하면 사용자에게 "반환 값이 없으므로 아무 것도 가정하지 않습니다"라고 알립니다. 반환 태그가 전혀없는 것은 사용자에게 "반환 값이 없다고 가정합니다"라고 알려줍니다. 하루가 끝날 때 기능적으로 모두 똑같습니다 ... 독자 분 께서 독자 분께 드리는 것이 얼마나 명백한 지에 달려 있습니다. 나는 항상 가정에'@return void '를 포함한다. 왜냐하면 나는 가정을 싫어하기 때문에 ;-) 위키를 인용하기 위해 – ashnazg

** @ return |이 태그는 void 반환 형식으로 정의 된 생성자 또는 메소드에 사용하면 안된다. ** – chiliNUT

선택하신 phpDoc은 각각의 경우에 함수를 인식합니다. 하지만 문자열을 반환하고 응답 문자열을 클래스 외부에 작성하려고 할 수 있습니다.

출처

2014-10-23 17:47:05

을하지 않습니다 항상 일한다. 예를 들어, 큰 파일의 내용을 출력하는 스크립트가 있습니다. 나는 그 파일이 얼마나 커질 지 깨닫지 못했고 함수에서 반환했을 때 스크립트가 메모리를 다 써버 렸습니다. 대신 많은 양의 메모리 근처에서 사용하지 않는 readfile로 전환되었습니다. – Gnuffo1

하는 PHPDoc 매개 변수없이 또는 반환 값

답변

관련 문제