有没有办法重复使用＆＃34;一个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

假设docblock实际上是相同的，通常情况下，当您覆盖继承的方法但保持相同的签名时，可以使用@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。

Documentation relating to this

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

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