php - phpDoc - 无参数或返回值

Question

假设我有以下类存根：

class Gentleman {

    /** @var string */
    protected $guestsName;

    /**
     * @param string $name The name of our esteemed guest
     */
    public function __construct($name) {
        $this->guestsName = $name;
    }

    public function beCourteous() {
        echo 'Salutations, dear ' . $this->guestsName;
    }

}

该beCourteous()方法实际上不接受任何输入，也不产生任何返回值。什么是正确的 phpDoc 块？

public function beCourteous() {
    // No docblock
    echo 'Salutations, dear ' . $this->guestsName;
}

/**
 *
 */
public function beCourteous() {
    // One blank line
    echo 'Salutations, dear ' . $this->guestsName;
}

/**
 */
public function beCourteous() {
    // No blank lines
    echo 'Salutations, dear ' . $this->guestsName;
}

Answer 1

不接受参数也不返回值的函数不应该在文档注释中包含@paramor 。@return但是，您可以（并且应该）仍然包含描述

/**
 * Echos a salutation to <code>$this->guestsName</code>
 */
public function beCourteous() {
    echo 'Salutations, dear ' . $this->guestsName;
}

见这里：（相关，不完全是骗子） PHPDoc：@return void 必要吗？

在这里： http ://en.wikipedia.org/wiki/PHPDoc

Answer 2

您选择的 phpDoc 将在每种情况下识别一个函数。但也许你想返回字符串并在类之外构建你的响应字符串。