Question

我在一些遗留代码中添加了一些注释，并且我在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不必要地抱怨，还是有一些明显的我不知道？

Answer 1

我在phpDocumentor版本2.8.1中遇到了同样的问题。看来这是这个版本中的一个错误： enter link description here

我使用了version 2.7.0，现在很好。

PHPDocumentor - 我的DocBlock出了什么问题？

1 个答案: