Come documentare un parametro che si aspetta una costante

Question

Qual è il modo consigliato per documentare la funzione oi parametri del metodo il cui valore è previsto essere una costante predefinita? Finora, uso il tipo di dati della costante e aggiungo una piccola spiegazione in seguito.

Esempio:

<?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

Dato che è possibile utilizzare una classe nota come il dataype nei tag param e return, mi aspetto anche che tu possa usare una costante conosciuta. Quando si desidera specificare più opzioni di tipo, è sufficiente delimitare l'elenco con le pipe. Modificando il tuo esempio:

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

Dal momento che il tipo di dati, in questo caso è un noto valore interno-to-the-class, potrebbe anche funzionare senza il prefisso nome di classe:

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

Answer 2

Here trova informazioni su come documentare costante utilizzando phpdoc

const/define significa lo stesso in php