17

例：

/**
 * This function will determine whether or not one string starts with another string.
 * @param string $haystack <p>The string that needs to be checked.</p>
 * @param string $needle <p>The string that is being checked for.</p>
 * @param boolean $case[optional] <p>Set to false to ignore case(capital or normal characters)</p>
 * @return boolean <p>If the $haystack string does start with the $needle string, the return will be true. False if not.</p>
 */
function endsWith($haystack,$needle,$case=true) {
    if($case){return (strcmp(substr($haystack, strlen($haystack) - strlen($needle)),$needle)===0);}
    return (strcasecmp(substr($haystack, strlen($haystack) - strlen($needle)),$needle)===0);
}

オプションのパラメータはtrue、デフォルトで に設定されています。ドキュメントにデフォルト設定が何であるかを示したいと思います。これを行う標準的な方法はありますか、それとも説明で言及する必要がありますか?

4

1 に答える 1

19

ドキュメントは言う：

$paramname,... は、パラメーター リストと関数シグネチャの両方の出力ドキュメントに表示されることに注意してください。パラメータがオプションであることを実際のコードで示していない場合 (「$paramname = 'a default value'」を介して)、パラメータの説明でパラメータがオプションであることを言及する必要があります。

したがって、関数の署名にデフォルトの割り当てを表示していない場合は、説明に含めることをお勧めしますが、あなたの場合は署名に含めています。気分が良くならない限り、何かを変える必要はありません。

于 2009-09-06T22:41:52.780 に答える