Comment décrire les propriétés de la classe en PHP 5 avec phpDocumentor

Prendre en considération les points suivants PHP 5 classe:

class SomeClass
{
    //I want to document this property...
    private $foo;


    function __construct()
    {

    }

    public function SetFoo($value)
    {
        $this->foo = $value;
    }

    public function GetFoo()
    {
        return $this->foo;
    }
}

Comment dans phpDocumentor je document de l' $foo propriété? Je ne suis même pas sûr qu'il doivent être documentés, mais je voudrais savoir comment, si si les besoins de...

Je sais comment le document SetFoo() et GetFoo(), je ne suis pas sûr au sujet de la propriété privée (variable?).

Merci!

InformationsquelleAutor AlexV | 2010-02-03
  1. 40
    /**
 * This is what the variable does. The var line contains the type stored in this variable.
 * @var string
 */
private $foo;
    InformationsquelleAutor Billy ONeal
  2. 17

    Je voudrais généralement utiliser au moins la @var balise pour indiquer le type de variable c'est.

    Par exemple :

    /**
 * Some blah blah about what this is useful for
 * @var MyClass $foo
 */


    C'est exactement ce qui est fait par le Zend Framework, par exemple ; voir Zend_Layout (en les citant) : 

    class Zend_Layout
{
    /**
     * Placeholder container for layout variables
     * @var Zend_View_Helper_Placeholder_Container
     */
    protected $_container;

    /**
     * Key used to store content from 'default' named response segment
     * @var string
     */
    protected $_contentKey = 'content';


    Remarque : le @access tag a été utile avec PHP 4 (quand il n'y avait pas de public/protected/private), mais je n'ai jamais l'utiliser quand je code de document, écrit en PHP 5 : le code, à l'aide de la visibilité des mots-clés est l'auto-documentation.

    • MyClass $foo doit être réellement @property MyClass $foo, basé sur la façon dont vous l'utiliser (et dans ce cas, @propriété suggère une magie var). Le Zend exemple que vous avez posté ne montrer de la bonne utilisation de @var
    • Merci pour le détail sur @access. C'est exctly ce que je cherchais quand j'ai trouvé cette page.
    • +1 -- mais le nom de la variable dans le commentaire de votre premier exemple?
    • le docblock qui vient avant une variable est l'un des documents que variable ; donc, je dirais que la variable nom est implicite (mais il pourrait être utile de vérifier comment il se comporte, juste pour être sûr)
    • Ouais.. je n'ai pas de PHPDocumentor disponible pour faire des tests en ce moment; mais je fais remarquer que votre deuxième exemple de Zend Frameowkr qui n'ont pas de noms...
    • Je n'utilise pas de phpDocumentor au travail, mais j'ai toujours mis des éléments pour aider à PHPStorm avec l'auto-complétion -- et je n'ai pas toujours mettre le nom de la variable soit.

    InformationsquelleAutor Pascal MARTIN
  3. 0

    Dans le cas où vous utilisez un __get et __set magique méthodes que vous pouvez utiliser @property

    /**
  * Description for the class
  * @property type $foo Description for foo
  * @property type $foo Description for bar
  */
 class SomeClass
 {
     private $foo;
     protected $bar;

     public function __get(){
         ...
     }

     public function __set(){
         ...
     }
 }

    Des liens avec plus d'info:

    InformationsquelleAutor David
  4. -1
    /**
 * docstring
 */
private $foo;

    Remarque importante: il doit être deux astérisques. Pas un seul.

    InformationsquelleAutor Alexander Chzhen