Подтвердить что ты не робот

PhpDocs: возможно ли связать метод в описании параметра?

Можно ли связать другой метод/класс/свойство/и т.д. внутри моего проекта внутри тега @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 рекомендует использовать @see в случае @deprecated метода:

РЕКОМЕНДУЕТСЯ (но не обязательна) предоставить дополнительное описание, указывающее, почему связанный элемент устарел. Если он заменен другим методом, РЕКОМЕНДУЕТСЯ добавить тег @see в том же PHPDoc, указывающий на новый элемент.