使用phpDocumentor,如何记录具有默认值的可选参数:
public function myMethod ($param = 1234)
{
// ...
}
如何在docblock中编写@param
标记以记录默认值?
答案 0 :(得分:2)
文件记录为here
如果你没有在实际代码中指出参数是可选的(通过“$ paramname ='默认值'”),那么你应该在参数的描述中提到参数是可选的。
因此,对于问题中的源代码,您无需执行任何操作。但是,如果您没有为可选参数包含默认值,则应在描述中包含一个注释,详细说明默认值。