web-dev-qa-db-ja.com

PHPDocを使用して複数行の@paramを表示する正しい方法は何ですか？

私が調査したところ、複数行の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つの長い行にまとめるだけでしょうか。

phpdocumentationphpdoc
26
Sean

あなたは単にこのようにそれを行うことができます：

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

したがって、1つのことを除いて、例は問題ありません。PHPDoc@ paramは、PHPパラメーターと同じ名前である必要があります。ドキュメントでは$ noun、実際のコードでは$ stringと呼びます。

24
Dany Caissy