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

医生说：

请注意，$paramname,... 将显示在参数列表和函数签名的输出文档中。如果您没有在实际代码中指明参数是可选的（通过“$paramname = 'a default value'”），那么您应该在参数描述中提及该参数是可选的。

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