example - docblocks php

¿Cuál es la forma correcta de mostrar un @param multilínea utilizando PHPDoc?

Question

Por lo que he investigado, parece que no puedo encontrar el método correcto para formatear una línea multilínea phpdoc @param . ¿Cuál es la forma recomendada de hacerlo?

Aquí hay un ejemplo:

/**
* 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;
}

¿Sería correcto, o no agregaría sangría, o simplemente mantendría todo en una sola fila?

Answer 1

Simplemente puedes hacerlo de esta manera:

 /**
*
* @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;
}

Entonces su ejemplo está bien, excepto por una cosa: PHPDoc @param necesita tener el mismo nombre que el parámetro PHP. Lo llamaste $ nombre en el documento y $ cadena en el código real.