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

2022-08-30 22:19:45

例:

/**
 * 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 = '默认值'”),那么您应该在参数的描述中提及该参数是可选的。

因此,如果您没有在函数签名中显示默认赋值,那么最好将其包含在描述中,但就您而言,您将它包含在签名中。所以,你不需要改变一件事,除非这样做会让你感觉更好。


答案 2

推荐