phpDoc — без параметров или возвращаемого значения
Скажем, у меня есть следующий класс заглушки:
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;
}
Решение
Функция, которая не принимает параметры и не возвращает значение, не должна иметь @param или же @return в комментарии к документу. Тем не менее, вы можете (и должны) по-прежнему включать описание
/**
* Echos a salutation to <code>$this->guestsName</code>
*/
public function beCourteous() {
echo 'Salutations, dear ' . $this->guestsName;
}
Смотрите здесь: (Связанный, не совсем дурак)
PHPDoc: необходимо возвращать пустоту?
И здесь:
http://en.wikipedia.org/wiki/PHPDoc
Другие решения
Ваш выбор phpDoc будет распознавать функцию в каждом случае.
Но, возможно, вы хотите вернуть строку и построить строку ответа вне класса.