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标签，但我仍然使用它们，因为它是一种很好的方式来暗示开发人员实现类/接口/特性。