PHPDoc 전제 조건

Question

PHPDoc으로 전제 조건을 태그하는 방법? 나는 객체를 가지고 있고, 함수를 호출하기 전에 다른 함수가 호출되어 있어야합니다 :

$myObject = new MyClass(); 
$myObject->mustDoThis(); 
$myObject->beforeThis(); 

그래서 beforeThis()에 대한 문서는 같을 것이다

/** 
* @precondition mustDoThis() must be called before this function is 
*/ 

또는이 주위에 또 다른 방법은 무엇입니까? 아마도 @throw 절로 충분할 것입니다.

Answer 1

필자가 아는 한, PhpDoc에는 표준 @precondition 또는 @postcondition 태그가 없지만 어쨌든 클래스/인터페이스/특성을 구현하는 개발자를 암시하는 좋은 방법이므로 필자는이를 사용합니다.