在另一个文件中扩展 PHPDoc/PHPStorm 文档答案

【问题标题】：Extend PHPDoc/PHPStorm Documention in another file在另一个文件中扩展 PHPDoc/PHPStorm 文档
【发布时间】：2013-08-09 11:17:58
【问题描述】：

我有一个实现__call() 方法的类（我称之为Example）。此方法允许扩展类以进行额外调用（基于其他数据）。对于这个问题，我假设其中之一是getDemoData()。

如果这个getDemoData() 函数在一个数组中具有一个键为Demo 的值，它将可用。返回值将是一个特定的类，在这种情况下，命名为Demo。

是否有可能扩展 PHPDoc 文档（直接归因于 PHPDoc，或 PHPStorm 本身的特殊内容），这将允许我在 Demo 中说 Example 有一个名为 Example::getDemoData() 的方法。

我知道我可以在类本身中使用@method 标记，但我不知道我是否可以在该类之外使用它（如果可以，我不确定语法）。

谢谢。

【问题讨论】：

【解决方案1】：

我认为在这种情况下你能做的最好的事情就是在 Demo 的类 docblock 中使用 @see 标记：

/**
 * @see Example::getDemoData()
 */
class Demo {}

假设您确实将 @method 放入了 Example 的类 docblock：

/**
 * @method Demo getDemoData()
 */
class Example {}

【讨论】：

谢谢。我曾想过这一点，但我不希望将该方法放入我的对象中，因为它仅在某些其他事物被连接时才存在。但是，它可能与我将得到的一样接近。我会再等一天，但我可能最终会接受这个答案。