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...
}
...
?
Решение
Согласно PHPdoc.org, вы можете использовать @увидеть тег для этого.
/**
* @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, указывающий на новый элемент.
Другие решения
Других решений пока нет …
detector