Phpdoc для установки значения по умолчанию для необязательного параметра?
Пример:
/**
* 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. Я хочу указать, что значение по умолчанию указано в документации. Есть ли стандартный способ сделать это или я должен упомянуть об этом в описании?
Ответы
Ответ 1
Документ говорит:
Обратите внимание, что $paramname,... будет показано в выходных документах как в Список параметров и функция подпись. Если вы не указали в фактическом коде, что параметр необязательно (через "$ paramname = 'a значение по умолчанию ''), тогда вы должны упоминание в описании параметра что параметр является необязательным.
Итак, если вы не показываете назначение по умолчанию в сигнатуре функции, было бы неплохо включить его в описание, но в вашем случае вы включаете его в подпись. Таким образом, вам не нужно ничего менять, если это не сделает вас лучше.
