对于itteratable对象有适当的phpdoc评论吗？

2019-07-08 20:30:40 阅读：338 来源： 互联网

标签：php iterator interface aggregate phpdoc

我在尝试为以下代码示例获取正确的自动完成时遇到了一些问题.我在Win7机器上使用PHPStorm 7.

首先只是一个简单的课程.

/**
 * Class myObject
 */
class myObject
{
    /**
     * some method
     */
    public function myMethod()
    {
        // do something
    }
}

这个是集合类,它可以包含先前类的多个实例,并实现ItteratorAggregate接口.

/**
 * Class myCollection
 */
class myCollection implements IteratorAggregate
{
    /**
     * @var myObject[]
     */
    protected $_objects = array();


    /**
     * @param myObject $object
     * @return myCollection
     */
    public function add(myObject $object)
    {
        $this->_objects[] = $object;

        return $this;
    }


    /**
     * @return ArrayIterator
     */
    public function getIterator()
    {
        return new ArrayIterator($this->_objects);
    }
}

这是代码示例.

$collection = new myCollection;

$collection->add(new myObject);
$collection->add(new myObject);

foreach ($collection as $object) {
    $object->myMethod(); // gets no autocompletion
}

正如您可能已经猜到的那样(并在示例中读取)myMethod()调用未自动完成,并且正在代码分析中列出.我找到的唯一方法是为$object添加一个注释块,我发现,说实话,非常讨厌.

/** @var $object myObject */
foreach ($collection as $object) {
    $object->myMethod(); // gets autocompletion now, but sucks
}

那么,关于如何解决这个问题的任何想法或基本知识？

解决方法:

您的

/ ** @var $object myObject * /

block确实是实现这一目标的正确方法.你期望做的工作的语法,

/ **
* @var myObject []
* /

虽然它是非正式使用并且正在进行标准化工作,但它不是标准的phpdoc表示法.在这种标准化确实发生之前,识别它的IDE可能会被击中或者错过.实际上,$object local var block的IDE覆盖率也是命中注定.

标签：php,iterator,interface,aggregate,phpdoc
来源： https://codeday.me/bug/20190708/1405783.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

对于itteratable对象有适当的phpdoc评论吗？