如何从另一个方法(不是我们正在覆盖的方法)继承phpdoc
我想知道是否有一个方法可以在相同和/或不同类中的不同方法上复制(继承)完全相同的phpdoc 我知道,它只提供从父类到子类的继承(正如人们所期望的:) 但是看看下面,我必须在3个不同的地方复制相同的描述,在同一个类中有2个方法,在一个单独的类中有一个(不是继承的,而是初始化的)。 我想知道是否有一种方法可以做到这一点,而不需要复制粘贴如何从另一个方法(不是我们正在覆盖的方法)继承phpdoc,php,phpdoc,Php,Phpdoc,我想知道是否有一个方法可以在相同和/或不同类中的不同方法上复制(继承)完全相同的phpdoc 我知道,它只提供从父类到子类的继承(正如人们所期望的:) 但是看看下面,我必须在3个不同的地方复制相同的描述,在同一个类中有2个方法,在一个单独的类中有一个(不是继承的,而是初始化的)。 我想知道是否有一种方法可以做到这一点,而不需要复制粘贴 提前感谢您的建议:){@inheritardoc}是内置的,不支持指定继承源。请使用@请参阅标签 这两种方法不太可能以相同的方式描述。如果它是一个代理,或者只是
提前感谢您的建议:)
{@inheritardoc}
是内置的,不支持指定继承源。请使用@请参阅标签
这两种方法不太可能以相同的方式描述。如果它是一个代理,或者只是传递数据,那么说明应该注意这种行为,@see
标记应该引导用户使用接口方法
我经常使用@see
和@link
标记链接到SAPI文档,或解析代理。也就是说,我总是尝试包含某种描述,并且总是记录参数和返回,即使它们是相同的(查看代码时会有所帮助)
小心不要过于依赖PHPDoc的快捷方式
class Example
{
/**
* here i want to have exactly the same phpdoc,
* like what i created for getMeSomethingFromTheShelf() in the same class
*/
public function getMeSomething($id, $option = [])
{
return $this->getMeSomethingFromTheShelf($id, $option);
}
/**
* Some description
* and some more detail about how the $option value will be used
*
* @param int $id
* @param array $option and here some we have some sample
* @return string
*/
public function getMeSomethingFromTheShelf($id, $option = [])
{
return 'here you go :)';
}
}
class AnotherClass
{
/**
* here also i want to have exactly the same phpdoc,
* like what i created for Example::getMeSomethingFromTheShelf() in the Example class
*/
public function fetchSomething($id, $option = [])
{
return (new Example)->getMeSomething($id, $option = []);
}
}