用于设置可选参数默认值的phpdoc标准？

Question

例子：

/**
 * 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。我希望在文档中指出默认设置。是否有执行此操作的标准方法，还是我必须在说明中提及？

Answer 1

The doc says:

注意 $paramname,... 将是 显示在两个输出文档中 参数列表和函数 签名。如果您不指示 在参数的实际代码中 是可选的（通过“$paramname = 'a 默认值'")，那么你应该 在参数说明中提及 该参数是可选的。

因此，如果您没有在函数签名中显示默认分配，最好将其包含在描述中，但在您的情况下，您 将其包含在签名中。所以，你不需要改变任何事情，除非这样做会让你感觉更好。