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

Question

Возможно ли связать другой метод/класс/свойство/и т. Д. внутри моего проекта inline внутри тега @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... 
} 

... 

?

Answer 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 recommends to use @see in case of a @deprecated method:

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