设置可选参数默认值的 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 :

Note that the $paramname,... will be shown in the output docs in both the parameter listing AND the function signature. If you are not indicating in the actual code that the parameter is optional (via "$paramname = 'a default value'"), then you should mention in the parameter's description that the parameter is optional.

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