2011-08-25 20 views
6

¿Cómo debo usar PHPdoc para documentar métodos encadenables en una clase, como se ve en el ejemplo a continuación? ¿Cuál es el uso correcto?PHPdoc: ¿Documentando métodos encadenables?

class myClass { 


    /** 
    * @return myClass 
    */ 
    function one() 
    { 
     return $this; 
    } 

    /** 
    * @return self 
    */ 
    function two() 
    { 
     return $this; 
    } 

    /** 
    * @return $this 
    */ 
    function three() 
    { 
     return $this; 
    } 

} 

Respuesta

6
/** 
* @return myClass 
*/ 

No soy un experto phpDoc pero es que así es como lo hacen en el marco de Zend. Así que creo que es fiable

+1

Esta opción tiende a funcionar mejor, especialmente con terminación automática IDE. – ashnazg

0

prefiero

/** 
* @return $this 
*/ 
+1

Bueno, ¿es eso * compatible * con PHPDoc? Eso es solo tiempo de ejecución, no documentación de código estático en mis ojos. – hakre

Cuestiones relacionadas