我在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>
发布于 2012-08-28 20:16:52
您可以使用@var标记来记录类变量的数据类型。
数据类型应该是有效的PHP类型(int、string、bool等)、对象类型的类名或简单的"mixed“。phpDocumentor将显示未修改的可选描述,如果数据类型不存在,则默认为“mixed
https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.var.pkg.html
使用@var标记可以记录类属性的类型和函数。当提供时,它必须包含一个类型来指示预期的内容;另一方面,描述是可选的,但建议在复杂结构的情况下使用,例如关联数组。@var标记可以有多行描述,并且不需要显式分隔。
建议在记录时对每个属性使用此标记。
此标记在PHPDoc中的每个属性中只能出现一次,并且仅限于类型为property的结构元素。
示例:
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();
}
发布于 2012-08-28 20:15:58
它们是PHPdoc注释,通常用于IDE类型的提示/代码完成(有时也会生成文档,但不是在这个场景中)。它们与应用程序本身无关,可以毫不费力地删除。
发布于 2012-08-28 20:16:50
它在内联类型提示中。
例如:
/* @var bool */
$switch
在本例中,它表示$this
的类型为CategoriesController
,而$data
的类型为Categories
通常由IDE用于类型提示。
https://stackoverflow.com/questions/12158987
复制相似问题