php - 有没有办法“重用”一个 PHP DocBlock？

Question

我目前有这样的代码：

/**
 * blah blah blah thing1
 *
 * @return string a thing1
 */
function thing1() {
    //
}

/**
 * blah blah blah thing2
 *
 * @return string a thing2
 */
function thing2() {
    //
}

//dozens more with the same format

有没有更简洁的方法来做到这一点？

Answer 1

假设文档块实际上是相同的，通常是当您覆盖继承的方法但保持相同的签名时，您可以使用@see....

abstract class MyBaseModel
    /**
     * @param Boolean $excludeDeleted Should soft-deleted records be excluded
     */
    public function newQuery($excludeDeleted = true)
    {
        ....
    }
}

class MyExtendedModel extends MyBaseModel
    /**
     * Overload the base newQuery() method so that we can inject any security filters into the query
     *
     * @see MyBaseModel::newQuery
     */
    public function newQuery($excludeDeleted = true)
    {
        ....
    }
}

thing1()但是您的示例文档thing2()块并不相同，因此在这种情况下没有简洁（懒惰）的方式

Answer 2

您可以使用@see 是否真的相同。

与此相关的文件

/**
 * blah blah blah thing1
 *
 * @return string a thing1
 */
function thing1() {
    //
}

/**
 * @see thing1
 */
function thing2() {
    //
}