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 默认值'“），那么你应该在参数的描述中提到该参数是可选的。

因此，如果您没有在函数签名中显示默认赋值，那么将它包含在说明中是个好主意，但在您的情况下，将其包含在签名中。所以，除非这样做会让你感觉更好，否则你不需要改变它。

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

1 个答案: