【问题标题】:PHPDoc preconditionsPHPDoc 前置条件
【发布时间】:2014-05-10 15:23:39
【问题描述】:

如何用 PHPDoc 标记前置条件?我有一个对象,在调用一个函数之前必须调用另一个函数:

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

所以beforeThis() 的文档看起来像:

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

或者还有其他方法可以解决这个问题吗?也许@throw 子句就足够了。

【问题讨论】:

    标签: phpdoc preconditions


    【解决方案1】:

    据我所知,PhpDoc 没有标准的 @precondition 或 @postcondition 标签,但我还是使用它们,因为这是提示开发人员实现类/接口/特征的好方法。

    【讨论】:

    • @see 可能是每种方法链接到另一种方法的最佳“标准”方式。然后标签的描述部分将描述它们之间的关系。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多