ide - 如何让 PHPStorm 像定义的那样处理一个函数？

Question

double_metaphone() 函数是在 PECL 扩展中定义的，因此 PHPStorm 看不到它的定义。我不想看到任何关于此的警告。我假设我可以让 PHPStorm 将这个函数调用视为通过某种注释定义的，但我不知道如何实现这一点。

Answer 1

您需要所谓的“ stub 文件”:

1. 创建一个 .php 文件并将其放置在项目的任何地方(无论是项目本身...还是作为外部库(设置| PHP | Include paths) -- 没关系，只要 PhpStorm 可以在这个项目中看到它)。

2. 像在 PHP 中那样添加该函数定义:描述所有参数、返回类型等，并将函数体留空。

   文档是可选的:它只是您拥有的文档越多，它对 PhpStorm 和您就越有用:IDE 可以警告您参数类型无效、返回类型使用不正确、使用代码完成时建议适当类型的变量对于该功能等

3. 就这样

这正是所有已知的 PHP 函数/类/等首先在 PhpStorm 中完成的方式:只需在任何标准函数/类/常量上 Ctrl + 单击 并自行查看。

一个例子:标准 bin2hex 函数是如何定义的(早在 2013 年):

<?php
/**
 * (PHP 4, PHP 5)<br/>
 * Convert binary data into hexadecimal representation
 * @link http://php.net/manual/en/function.bin2hex.php
 *
 * @param string $str A character.
 * @return string the hexadecimal representation of the given string.
 */
function bin2hex ($str) {}

您可以在此官方存储库中查看所有当前的 PhpStorm stub (以及 IDE 用于 PHP 完成的其他帮助文件):https://github.com/JetBrains/phpstorm-stubs