Какой рекомендуемый способ документирования параметров функции или метода, значение которых, как ожидается, будет предопределенной константой? Пока что я использую тип данных константы и добавлю небольшое пояснение позже.
Например:
<?php
class Foo{
const METHOD_GET = 'get';
const METHOD_POST = 'post';
/**
* Load a new foo
*
* @param string $method HTTP method to use (either Foo::METHOD_GET or Foo::METHOD_POST)
*/
public function load($method=Foo::METHOD_POST){
// ...
}
/**
* Sort current foo
*
* @param int $sort_order Sort order (either SORT_ASC or SORT_DESC)
*/
public function sort($sort_order=SORT_ASC){
// ...
}
}