TL;博士
如何使用 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 显示错误:“未定义的常量 '...\ABSPATH' (1011)”(其中的点是我为简洁起见省略的命名空间)。
所以看起来 intelephense 没有接受第一行暗示的条件——即如果ABSPATH
没有定义,执行将不会到达引用它的后面的代码。(这很好,程序流分析可能要求太多)。无论如何,我认为我应该能够添加某种 PhpDoc(或其他注释注释)以向代码分析器表明该变量已定义。像这样的东西:
/**
* @var string ABSPATH
*/
或这个:
/**
* @global string ABSPATH
*/
但这些都不会导致错误消失。(我也尝试过@const
似乎不是真正的标签。它也不起作用。)
代码中是否有某种方式可以表明 ABSPATH 是在外部代码中定义的,还是在外部范围内定义的?在函数顶部添加一行 likeglobal ABSPATH;
似乎也不正确,因为ABSPATH
它不是变量。这是一个define
-created 常量。
谢谢!