Question

Dikkate aşağıdaki PHP 5 sınıf almak:

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

Nasıl phpDocumentor I $ foo özelliği belge olacak? Ben belgelenmiş olması gerek bile emin değilim ama ben bilmek istiyorum nasıl eğer ihtiyaçları varsa ...

Ben sadece özel mülkiyet hakkında emin değilim, SetFoo () ve GetFoo () belgelemek için nasıl biliyor (değişken?).

Teşekkürler!

Answer 1

Ben genellikle bu değişkenin türünü belirtmek için, en azından @var etiketini kullanabilirsiniz.

Örneğin:

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

This is exactly what's done by Zend Framework, for instance ; see Zend_Layout (quoting) :

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

Note : the @access tag was useful with PHP 4 (when there were no public/protected/private), but I never use it when I document code written in PHP 5 : the code, using the visibility keywords is self-documenting.

Answer 2

Eğer bir __ get ve __ set sihirli yöntemler kullanabilirsiniz @property kullanın

/**
  * 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(){
         ...
     }
 }

Daha fazla bilgi ile bağlantılar:

PhpDocumentor ile PHP 5 sınıf belge özelliklerine nasıl

2 Cevap

etiketler