예외는 언제 문서화해야합니까?

Question

는 다음 코드 가정 : dependency::bar()이 예외를 발생하는 것으로 알려져있다

public function foo() 
{ 
    return $this->dependency->bar(); 
} 

경우,하지만 foo()는 그것을 처리 할 것으로 예상되지 않는다. foo()에 @throws 항목이 docblock에 있습니까? 아니면 암묵적이어야합니까? phpdoc 문서는 다소 모호합니다.

dependency이 인터페이스를 기반으로 주입된다고 가정하면; 인터페이스 문서는 수 예외를 throw 할 수 있습니다.

예외가 호출 코드에서 처리되어야하는지 또는 상황과 관련이없는 것이 중요합니까?

의미는 모든 방법 :

Answer 1

당신은 (모든 사람이 사용할 수 있습니다) 예외를 던질 수있는 몇 가지 경우에 어떤 공공 기능을 만들었습니다 - 따라서 당신은 확실히 당신의 docblock에 @throws 항목이 있어야합니다.
예외가 종속성에서 벗어난 경우 - 내부 구현이고 캡슐화 됨 - 따라서 함수를 사용하는 누군가는 함수에서 기대하는 바가 전혀 없습니다.

인터페이스 삽입의 경우 - 인터페이스는 모든 예외를 설명해야합니다. 예외는 클래스 및 인터페이스의 동작의 일부이므로 모든 가능한 동작을 설명해야합니다.

try-catch 블록이 있고 종속성의 모든 예외를 처리하는 경우 - 자신의 예외 만이 해당 블록의 @throws 항목에 있어야합니다.