Каков правильный способ отображения многострочного @param с использованием PHPDoc?
Из того, что я провел исследование, я не могу найти правильный метод для форматирования многострочной строки phpdoc @param. Каков рекомендуемый способ сделать это?
Вот пример:
/**
* Prints 'Hello World'.
*
* Prints out 'Hello World' directly to the output.
* Can be used to render examples of PHPDoc.
*
* @param string $noun Optional. Sends a greeting to a given noun instead.
* Input is converted to lowercase and capitalized.
* @param bool $surprise Optional. Adds an exclamation mark after the string.
*/
function helloYou( $noun = 'World', $surprise = false ) {
$string = 'Hello ' . ucwords( strtolower( $string ) );
if( !!$surprise ) {
$string .= '!';
}
echo $string;
}
Будет ли это правильно, или вы не добавите отступы, или просто сохраните все на одной длинной линии?
Ответы
Ответ 1
Вы можете просто сделать это следующим образом:
/**
*
* @param string $string Optional. Sends a greeting to a given noun instead.
* Input is converted to lowercase and capitalized.
* @param bool $surprise
*/
function helloYou( $string = 'World', $surprise = false )
{
$string = 'Hello ' . ucwords( strtolower( $string ) );
if( !!$surprise ) {
$string .= '!';
}
echo $string;
}
Итак, ваш пример хорош, за исключением одного: PHPDoc @param должен иметь то же имя, что и параметр PHP. Вы назвали его $существительным в doc и $string в фактическом коде.
