使用 phpDocumentor 记录 PHP 中可选参数的默认值

Question

使用phpDocumentor，如何记录具有如下默认值的可选参数：

public function myMethod ($param = 1234)
{
    // ...
}

如何在文档块中写入@param 标记以获取记录的默认值？

Answer 1

文档是here

如果你没有在实际代码中指明参数是可选的（通过“$paramname = 'a default value'”），那么你应该在参数的描述中提到参数是可选的。

因此，对于您问题中的源代码，您无需执行任何操作。但是，如果您不包含可选参数的默认值，则应在说明中包含详细说明默认值的注释。