standard phpdoc pour la mise en valeur par défaut d'un paramètre optionnel?

Question

Exemple:

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

Le paramètre optionnel est réglé sur true par défaut. Je tiens à indiquer ce que le réglage par défaut est dans la documentation. Est-il un moyen standard de faire ceci ou dois-je mentionner dans la description?

Answer 1

Le doc dit :

  

Notez que le paramname de $, sera ...   représenté dans les documents de sortie à la fois le   Liste des paramètres et la fonction   Signature. Si vous n'êtes pas indiquez   dans le code réel que le paramètre   est en option (via « $ paramname = « a   valeur par défaut "), alors vous devriez   mentionner dans la description du paramètre   que le paramètre est facultatif.

Donc, si vous n'êtes pas pour l'affectation par défaut dans la signature de la fonction, ce serait une bonne idée de l'inclure dans la description, mais dans votre cas, vous sont , y compris dans la signature. Donc, vous n'avez pas besoin de changer une chose à moins que cela ne vous faire sentir mieux.