PHPDocumentor可选参数

Question

我试图为以下内容编写phpdocumentor块：

/**
 * daysBetween
 *
 * Returns the number of whole working days between start_date and end_date. Working
 * days exclude weekends and any dates identified in holidays.
 * Use NETWORKDAYS to calculate employee benefits that accrue based on the number of
 * days worked during a specific term.
 *
 * @param   DateTime    $startDate     Start date
 * @param   DateTime    $endDate       End date
 * @param   DateTime    $holidays,...  Optional series of dates that will be excluded
 * @return  integer    Interval between the dates
 */
public function daysBetween($startDate,$endDate) {
    //  Shift the mandatory start and end date that are referenced 
    //  in the function definition, to get any optional days
    $holidays = func_get_args();
    array_shift($holidays);
    array_shift($holidays);

$startDate和$endDate是强制参数，而$holidays的所有实例都是可选的.可能没有定义一个或多个$holiday日期。上面的PHPDocumentor定义给了我

参数$holidays .在daysBetween()中找不到

我相信我可以通过将方法定义修改为

public function daysBetween($startDate,$endDate,$holidays=NULL) {

但是这感觉很混乱，我不认为我应该改变我的函数定义来记录它。还有人有其他建议吗？

我用的是PHPDocumentor2

Answer 1

的当前语法

* @param   DateTime    $holidays,...  Optional series of dates that will be excluded

根据param标签1的phpDocumentor手册，这个页面显示了"$holidays，.“语法应该足够让phpDocumentor识别一个没有直接出现在代码的方法签名中的可选参数。

这个“参数$holidays，.在daysBetween()中找不到”响应可能需要在github页面2上打开一个新的问题。

1- http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.param.pkg.html

2 -- https://github.com/phpDocumentor/phpDocumentor2/issues/424