Netbeans (PHP) 中的变量类型提示

Question

只是好奇 Netbeans 中是否有一种方法可以为常规变量提供类型提示，以便智能感知能够识别它。我知道你可以对类属性、函数参数、返回类型等执行此操作，但我不知道如何对常规变量执行此操作。当您有一个可以返回不同对象类型（如服务定位器）的方法时，这确实很有帮助。

例如：

/**
 * @var Some_Service $someService
 */
$someService = ServiceLocator::locate('someService');

如果之后使用 $someService，netbeans 将提供 Some_Service 类中定义的所有可用方法。

Answer 1

您只需要一行即可：

/* @var $varName Type_Name */

请参阅 NetBeans PHP 博客中的这篇文章：https://blogs。 oracle.com/netbeansphp/entry/defining_a_variable_type_in

注意：至少在 8.2 版本中；关键似乎是：

• 单个星号（/* 而不是 /**）。
• 将类型放在变量名称后面。
• 在类型提示之前和之后没有任何内容
  （除了空格，但即使这样也是不允许的
  当注释不在一行中时）。

Answer 2

我知道这是一个较旧的问题，但我一直在为 Eclipse/Zend Studio 寻找类似的答案，这也解决了它。

**但请注意，它必须在单行上，并以这种样式明确打开和关闭...

/* @var $varName Type_Name */

没有其他格式，无论...

/**
 * @var $varName Type_Name
 */ 

或...

// @var $varName Type_Name

似乎都可以工作。希望对某人有帮助。

Answer 3

您是否想要记录那些讨厌的神奇变量？ （我做到了；这个问题目前在 Google 中排名最高。我希望这对某人有帮助！）

@property 标签允许您记录神奇 php 变量 - 那些已实现的变量使用 __get() 和 __set()。该标签应在紧接类定义之前的文档中使用：

/**
 * Class Contact
 * @property string $firstName
 * @property string $lastName
 */
class Contact extends Model {
   ...

此表示法会触发自动完成，已在 Netbeans 8.1 和 PhpStorm 2016.1 中进行了测试。

Answer 4

根据此错误报告，语法将在NetBeans 9：

/* @var $variable VarType */    // vdoc1 (legacy syntax)
/** @var VarType $variable */   // vdoc (new syntax)

此外，值得一提的是，您可以将 [] 附加到类名以指示数组对象：

/* @var $foos Foo[] */
$foos = // ...

foreach ($foos as $foo) {
    // $foo will be hinted as Foo here
}

不要忘记您的 use 语句，例如 use Foo;

Answer 5

在 netbeans 8.0.2 中，vdoc 模板为您提供了以下信息：

/* @var $variable type */

但是 Netbeans 不会识别这一点，并且不会为您的对象提供正确的自动完成列表。相反，在变量声明之前使用它：

/** @var objectType $varName */

我还没有真正看到库存 vdoc 模板的巨大用途，特别是对于将用作 PDO 或 PDOStatement 对象的类变量。

我使用的一种解决方案实际上是进入
工具/选项/编辑器/代码模板（选择 PHP 作为您的语言），然后添加一个新模板。我调用了我的提示。然后在扩展文本下，使用以下模板：

/** @var ${VAR_TYPE variableFromNextAssignmentType default="ClassName"} $${VARIABLE variableFromNextAssignmentName default="variable"} */

Answer 6

对于 NetBeans IDE 8.2 语法如下：

class foobar{
    /** @var string $myvar: optional description here **/
    protected static $myvar;
}

这至少会为静态变量正确提供类型提示。