Вопросы Теги

Как к свойствам класса документов в PHP 5 с phpDocumentor

Возьмите в соображении следующий класс PHP 5:

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

Как в phpDocumentor я зарегистрирую свойство $foo? Я даже не уверен, что это должно быть зарегистрировано, но я хотел бы знать как если если потребности к...

Я знаю, как зарегистрировать SetFoo () и GetFoo (), я просто не уверен в частной собственности (переменная?).

Спасибо!

26
задан AlexV 3 February 2010 в 19:28
поделиться

2 ответа

/**
 * This is what the variable does. The var line contains the type stored in this variable.
 * @var string
 */
private $foo;
41
ответ дан 28 November 2019 в 06:48
поделиться

Я бы обычно использовал по крайней мере тег @var , чтобы указать тип переменной.

Например: 

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


Это именно то, что делает, например, Zend Framework; см. Zend_Layout (цитата) : 

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


Примечание: тег @access был полезен с PHP 4 (когда не было public / protected / private ) , но я никогда не использую его, когда документирую код, написанный на PHP 5: код, использующий ключевые слова видимости, самодокументируется.

17
ответ дан 28 November 2019 в 06:48
поделиться
Другие вопросы по тегам:

Похожие вопросы: