Документирование значений по умолчанию для дополнительных параметров в PHP с помощью phpDocumentor

С помощью phpDocumentor как документировать необязательный параметр, имеющий значение по умолчанию, подобное этому:

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

Как мне написать тег @param в блоке документации, чтобы задокументировать значение по умолчанию?


person Desmond Hume    schedule 03.05.2014    source источник


Ответы (1)


Документация находится здесь

Если вы не указываете в фактическом коде, что параметр является необязательным (через «$ paramname = 'значение по умолчанию'»), тогда вы должны указать в описании параметра, что параметр является необязательным.

Итак, для исходного кода в вашем вопросе вам ничего не нужно делать. Но если вы не указали значение по умолчанию для необязательного параметра, вы должны включить примечание в описание с подробным описанием значения по умолчанию.

person Thomas Coulter-Brophy    schedule 12.09.2014
comment
stackoverflow.com/questions/1386913/ - person Thomas Coulter-Brophy; 12.09.2014
comment
Кроме того, я понимаю, что вам, вероятно, не понадобился этот ответ через 4 месяца - я не смог проверить дату. - person Thomas Coulter-Brophy; 12.09.2014
comment
Ссылка, которой вы поделились, больше не действительна - person Andrey Izman; 05.06.2017