在 php 中注释局部变量

php variables phpdoc local

2022-08-30 13:22:00

我正在使用Eclipse PDT，我想使用Phpdoc注释局部变量。

我所看到的只是，我可以使用甚至注释类的变量/属性，但是对于局部变量，这怎么可能呢？@var@property

我该怎么做？

function foo(){
  /** @var Stock $a */
  $a->save();
}

答案 1

Phpdoc标准不涵盖这些注释（它只涵盖带有标签的类属性）;但是，在Eclipse中完全有可能（例如PDT）：@var

/* @var $variable Type */
 ^         ^        `--- type
 |      variable           
 |
 `--- single star

这也适用于所有其他PHP IDE，如Netbeans或Phpstorm，如果您与他人交换代码，这将非常有用。

示例代码：

<?php

/* @var $doc DOMDocument */
$doc->

示例屏幕截图（Eclipse PDT （Indigo））：

Eclipse PDT (Indigo)

相关问题和答案：

答案 2

这是一个老问题，但仅供参考。您必须在当前文件中包含的语句才能进行注释工作UseType@var

<?php
use YourVendor\YourBundle\Entity\ProductType;

...

/* @var $product_type ProductType */
$foo = $product_type->getName();