php - 你能为一个类创建一个外部 PHPdoc 吗？

Question

假设我有以下内容

class Something extends ClassWithMagicMethods{}

通常我会为我知道存在的任何属性添加一个文档 block ，即使通过魔术方法访问也是如此

/**
 * @property string $someVar
 * @method SomeClass getSomeClass()
 */
class Something extends ClassWithMagicMethods{}

效果很好，但我想知道我们是否可以将该文档 block 与类的定义分开。两个可能的用例:

• 不包含文档 block 的第三方包，但我希望从我的 IDE 自动完成 - 我希望能够在某处为其添加我自己的文档 block 。
• 扩展系统 - 在定义扩展的文件中，我想记录此扩展添加到类中的新属性。

我知道我可以在技术上创建一个永远不会真正运行的虚拟 ide_helper.php 文件 - 只是由 IDE 索引 - 不幸的是，这会导致任何像样的 IDE 提示我没有的重复声明' want 因为它也会使代码导航变慢。

那么 - 是否可以通过在类定义外部组合多个文档 block 来记录 PHP 类？

我在 SO 上获得的大部分结果都只是引用记录未知类型，而这不是我需要的。即:

/** @var Something $something */
$something = FactoryMethodThing::create('Something');

Answer 1

看看这是否对你有帮助:

phpdoc -d path/to/my/project -f path/to/an/additional/file -t path/to/my/output/folder

来源:http://docs.phpdoc.org/guides/running-phpdocumentor.html