standard phpdoc per l'impostazione del valore predefinito di un parametro opzionale?

Esempio:

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

Il parametro opzionale è impostato su true per impostazione predefinita. Desidero indicare quale è l'impostazione predefinita nella documentazione. C'è un modo standard per farlo o devo menzionarlo nella descrizione?

Il documento dice :

Nota che $ paramname, … verrà mostrato nei documenti di output sia nella list parametri che nella firma della function. Se non si sta indicando nel codice effettivo che il parametro è facoltativo (tramite "$ paramname = 'un valore predefinito'"), allora nella descrizione del parametro si dovrebbe menzionare che il parametro è facoltativo.

Quindi se non stai mostrando il task predefinito nella firma della function, sarebbe una buona idea includerlo nella descrizione, ma nel tuo caso lo stai includendo nella firma. Quindi, non è necessario cambiare una cosa a less che farlo non ti faccia sentire meglio.