Я добавляю некоторые комментарии в некоторый унаследованный код и столкнулся с небольшой проблемой с PHPDocumentor.
Вот пример:
/**
* Constructs the Widget object
*
* Basic constructor for the widget object.
* Another line of pointless explanation, badly worded.
*
* @param string $id The ID of the widget
* @param int $size The Size of the widget
* @return void
* @throws InvalidArgumentException
*/
public function __construct($id, $size) {
if (!is_string($id) || !is_integer($size)) {
throw new InvalidArgumentException('$id must be a string, $size an integer');
}
$this->id = $id;
$this->size = $size;
}
Я запускаю PHPDocumentor из командной строки и получаю прекрасную папку, полную документации.
Документация выглядит хорошо, но я получаю ошибки компиляции PHPDocumentor в виде:
Argument $id is missing from the Docblock of __construct
Это просто PHPDocumenator нытье излишне, или есть что-то очевидное, что мне не хватает?
У меня была такая же проблема с phpDocumentor версии 2.8.1. Кажется, это ошибка в этой версии:
введите описание ссылки здесь
я использовал версия 2.7.0 и теперь все в порядке.
Других решений пока нет …