我如何声明在 PhpDoc 中定义了一个常量（对于 intelephense）？

Question

TL;DR

如何使用 PhpDoc/DocBlocks 记录在外部代码中定义的常量，以便它不会在静态代码分析中显示为未定义的变量？

详情：

我正在尝试编写一个小型 WordPress 插件。我有一些 PHP 代码如下。

defined('ABSPATH') or die('Access denied!'); // Avoid direct file request

function getPluginInfo($key) {
    require_once ABSPATH . '/wp-admin/includes/plugin.php';
    $data = get_plugin_data(MY_PLUGIN_FILE, true, false);
    return $data[$key];
}

我正在使用 VSCode 插件 vscode-intelephense（它提供 PHP 语言服务）。我安装了所有必要的依赖项，包括在 VSCode 设置中将“wordpress”列为存根。总的来说，intelephense 工作得很好，并且在显示有关我的代码和 WordPress 库代码的信息方面做得很好。

但是 intelephense 显示错误："Undefined constant '...\ABSPATH' (1011)"（其中的点是我为简洁起见省略的命名空间）。

因此，似乎 intelephense 不会根据第一行隐含的条件进行处理——也就是说，如果 ABSPATH 未定义，则执行将不会到达引用它的后续代码。（这很好，程序流分析可能要求过高）。无论如何，我认为我应该能够添加某种 PhpDoc（或其他注释注释）以向代码分析器指示变量 已定义 。像这样：

/**
 * @var string ABSPATH
 */

或者这个：

/**
 * @global string ABSPATH
 */

但是这些都不会导致错误消失。（我也尝试了 @const，它似乎不是真正的标签。它也没有用。）

代码中有什么方法可以表明 ABSPATH 是在外部代码或外部范围中定义的吗？在函数顶部添加一行 global ABSPATH; 似乎也不正确，因为 ABSPATH 不是变量。这是一个 define 创建的常量。

谢谢！

Answer 1

类似于您启用的 wordpress 存根以提供 wp intellisense，您必须为您的常量创建一个存根文件并将其添加到您的工作区以便对其进行索引。

<?php

const ABSPATH = '';

我如何声明在 PhpDoc 中定义了一个常量（对于 intelephense）？

How can I declare that a constant is defined in PhpDoc (for intelephense)?

php

wordpress

phpdoc

docblocks

intelephense

TL;DR

详情：