是否可以从 PHP (PhpStorm/IntelliJ) 中的不同文件加载类的文档字符串?

问题描述

在我的 Laravel 应用程序中,我创建了一个脚本,将我的模型类的属性导出到 TypeScript 接口。多亏了这些接口,我的 IDE 知道 TypeScript 对象应该具有哪些属性

现在,我想更进一步,让我的 IDE 也知道每个 PHP 类的属性。为此,我想在单独的文件中创建 PHP Docstring 定义并将它们链接到实际的类文件。手动设置链接就可以了。

我的目录结构如下:

/classes/MyModel.PHP
/deFinitions/MyModel.PHP

类的定义文件应该只包含类的文档字符串:

// file: /deFinitions/MyModel.PHP
/**
 * @var string $myStringAttribute
 */

现在,我想以某种方式将这个生成文件包含在 MyModel 类中,这样任何 IDE 都可以知道模型可以从数据库访问哪些属性。我已经尝试将定义文件包含在 include __DIR__ . '/../deFinitions/MyClass.PHP' 中,但这不起作用。

在实际的类文件输出 Docstring 定义对我来说并不是一个真正的选择。对于单独的文件,我只需要向类添加一行代码即可链接定义。

有没有办法做到这一点?或者也许我的 IDE (PHPStorm/IntelliJ) 有插件可以做到这一点(官方 Laravel 插件没有做到这一点)?

这是一个生活质量问题。我知道我可以自己为每个类编写文档字符串,但我更喜欢让它们自动生成,以便与数据库中的实际模型定义保持一致,而无需手动操作。

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)