Question

Take in consideration the following PHP 5 class:

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;
    }
}

How in phpDocumentor will I document the $foo property? I’m not even sure it need to be documented but I would like to know how if if needs to…

I know how to document SetFoo() and GetFoo(), I’m just not sure about the private property (variable?).

Thanks!

Answer 1

/**
 * This is what the variable does. The var line contains the type stored in this variable.
 * @var string
 */
private $foo;