2015-11-23 4 views
0

У меня есть этот DocBlock в PHP абстрактного класса:PhpDocumentor: DocBlock с @var тегами дублирует описания

/** 
* @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 один) и уценки не разобранные тоже. С другой стороны, уценка тега @todo правильно разобрана.

Где я ошибаюсь? Я что-то пропустил?

Я нашел ошибку ticket about markdown in @var tags: Может, это связано с этой проблемой?

ответ

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; 
+0

Спасибо Machavity, он решил первую проблему (описания теперь относятся к правильным переменным). Есть еще две вещи: 1) markdown все еще не разобран 2) в документации [phpDocumentor] (http://www.phpdoc.org/docs/latest/references/phpdoc/tags/var.html) есть один пример DocBlock с 2 '@ var', так что, возможно, есть способ. – Pado

Смежные вопросы