Cómo documentar un parámetro que espera una constante

Question

¿Cuál es la forma recomendada de documentar los parámetros de función o método cuyo valor se espera que sea una constante predefinida? Hasta ahora, uso el tipo de datos de la constante y agrego una pequeña explicación más adelante.

Ej:

<?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){ 
     // ... 
    } 
} 

Answer 1

considerando que se puede utilizar una clase conocida como la dataype en las etiquetas param y return, también esperaría que puedas usar una constante conocida. Cuando desee especificar múltiples opciones de tipo, solo delimite la lista con pipes. La modificación de su ejemplo:

/** 
* Load a new foo 
* 
* @param Foo::METHOD_GET|Foo::METHOD_POST $method HTTP method to use 
*/ 
public function load($method=Foo::METHOD_POST){ 
    // ... 
} 

Dado que el tipo de datos en este caso es un conocido valor interno a la clase, incluso podría funcionar sin el prefijo de nombre de clase:

* @param METHOD_GET|METHOD_POST $method HTTP method to use 

Answer 2

Here se encuentra información sobre cómo documentar constante utilizando phpdoc

const/definir significa lo mismo en php