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

Question

根據我的研究，我似乎無法找到格式化多行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;

}

這是正確的，還是你不會添加縮進，或者你只是把所有東西放在一條長線上？

Answer 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中稱它為$ noun。