在php中注释一个局部变量

时间:2013-01-02 00:37:01

标签: php variables local phpdoc

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

我所看到的是,我可以使用@var甚至是注释类的变量/属性 @property,但这对局部变量有何影响?

我该怎么办?

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

2 个答案:

答案 0 :(得分:57)

Phpdoc标准未涵盖这些注释(它仅涵盖具有@var标记的类属性);但是,它完全可以在Eclipse(例如PDT)中使用:

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

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

示例代码:

<?php

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

示例屏幕截图(Eclipse PDT(Indigo)):

Eclipse PDT (Indigo)

相关问题&amp;回答:

答案 1 :(得分:5)

这是一个老问题,但仅供参考。 您必须在当前文件中包含Use的{​​{1}}语句才能进行Type注释工作

@var