php注释中@var的含义是什么

php

2022-08-30 16:39:05

我在php评论中看到了很多（@var），不知道它是什么意思。请告诉。

// example.php (taken from yii framework application code)

<?php
/* @var $this CategoriesController */
/* @var $data Categories */
?>

<div class="view">

    <b><?php echo CHtml::encode($data->getAttributeLabel('idCategory')); ?>:</b>
    <?php echo CHtml::link(CHtml::encode($data->idCategory), array('view', 'id'=>$data->idCategory)); ?>
    <br />
</div>

答案 1

您可以使用 @var 标记来记录类变量的数据类型。

数据类型应该是有效的PHP类型（int，string，bool等），对象类型的类名，或者只是“混合”。phpDocumentor 将显示未修改的可选描述，如果数据类型不存在，则默认为“混合”

https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.var.pkg.html

使用@var标记，可以记录类属性的类型和函数。当提供时，它必须包含一个类型来指示预期的内容;另一方面，描述是可选的，但在复杂结构的情况下建议使用，例如关联数组。

@var标记可能具有多行描述，不需要显式分隔。

建议在记录时将此标记用于每个属性。

此标记不得在 PHPDoc 中每个属性出现多次，并且仅限于属性类型的结构元素。

例：

class DemoVar
{
   /**
    * Summary
    *
    * @var object Description
    */
   protected $varWithDescriptions;

   /**
    * @var \DemoVar $instance The class instance.
    */
   protected static $instance;

   /**
    * Summary for varWithWrongType
    *
    * @var boolean The varWithWrongType. Boolean will be put in the type.
    */
   protected $varWithWrongType = array();
}

答案 2

它们是 PHPdoc 注释，通常用于 IDE 类型隐藏/代码完成（有时也用于文档生成，但在此方案中不然）。它们与应用程序本身无关，可以删除而不会发生任何事件。