PhpDocs：可以在参数描述中链接方法吗？

php documentation phpdoc phpdocumentor2

2022-08-30 23:25:51

是否可以链接到标记内内联到我的项目中的另一个方法/类/属性/等？喜欢这个：@deprecated

/**
 * Method description
 * @deprecated 1.0 Reason for deprecation, use {@link newMethod()} instead!
 * @param string $str
 * @param string|null $str2
 * @return bool
*/
public function method($str, $str2) {
    // TODO: Code...
}

...

?

答案 1

根据 PHPdoc.org，您可以使用@see标签。

 /**
 * @see http://example.com/my/bar Documentation of Foo.
 * @see MyClass::$items           For the property whose items are counted.
 * @see MyClass::setItems()       To set the items for this collection.
 *
 * @return integer Indicates the number of items.
 */
function count()
{
     <...>
}

此外，PHPdoc.org 建议在@deprecated方法的情况下使用@see：