【问题标题】:phpDocumentor: DocBlock with @var tags duplicates descriptionsphpDocumentor:带有@var标签的DocBlock重复描述
【发布时间】:2015-11-23 18:17:42
【问题描述】:

我在 php 抽象类中有这个 DocBlock:

/**
* @var string $foo a useful foo and <code>some.code()</code> too
* @var string $bar a useless bar
*
* @todo do something with <code>$this->bar</code>
*/
protected $foo, $bar;

我用 phpDocumentor 解析了这个类;这是html结果:

正如您所见,$foo 和 $bar 共享相同的描述($foo 之一)并且 Markdown 也没有被解析。 另一方面,@todo 标签的 markdown 被正确解析。

我哪里错了? 我错过了什么吗?

我发现了一个错误ticket about markdown in @var tags: 可能与这个问题有关吗?

【问题讨论】:

    标签: php phpdoc phpdocumentor2


    【解决方案1】:

    我总是在 var 本身之上记录。也许这就是问题

    /**
    * @var string $foo a useful foo and <code>some.code()</code> too
    */
    protected $foo;
    /*
    * @var string $bar a useless bar
    *
    * @todo do something with <code>$this->bar</code>
    */
    protected $bar;
    

    【讨论】:

    • 感谢 Machavity,它解决了第一个问题(描述现在指的是正确的变量)。还有两件事:1)markdown 仍然没有被解析 2)在 phpDocumentor 的 documentation 中有一个带有 2 @var 的 DocBlock 示例,所以也许有办法。
    猜你喜欢
    • 1970-01-01
    • 2013-05-28
    • 2014-12-27
    • 1970-01-01
    • 2021-02-05
    • 1970-01-01
    • 2015-07-14
    • 2012-01-24
    • 1970-01-01
    相关资源
    最近更新 更多