使用 PHPDoc 显示多行@param的正确方法是什么？

php documentation phpdoc

2022-08-30 13:42:36

从我所做的研究来看，我似乎找不到一种正确的方法来格式化多行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参数具有相同的名称。您在文档中将其称为$noun，并在实际代码中$string。

答案 2