phpDocumentor küresel @ ve isim soruya @

2 Cevap php

İlk gün ben phpDocumentor kullanımı ve şimdiye kadar çok iyi, ama ben ... kılavuzda küresel değişkenler belgelerine anlayamadım bir sorum var.

Eğer nasıl bu kodu belge olacaktır:

  1. $ SomeGlobalVar (hatta undelared olabilir) sınıfı PHP dosyasında not decalren olduğunu.
  2. $someGlobalVar = array(); (phpDocumentor kılavuzda gibi superglobal dizi kullanarak değil): $ someGlobalVar böyle ilan edildi.

PHP kodu:

class myCustomClass
{
    private $someProperty;

    //I want to document the use of global var in this method
    public function getSomeProperty()
    {
        global $someGlobalVar;

        if (isset($someGlobalVar))
        {
            //...
        }
        else
        {
            //...
        }
    }
}

Edit: Ben manuel olarak gösterir belgeyi bu küresellerle yapmak istiyorum ama ben @ küresel ve isim etiketleri @ koymak nasıl / nerede emin değilim.

Edit 2: Ben sadece getSomeProperty ilanından önce aşağıdaki satırları kullanarak sona erdi:

/**
 * Get some property based on the $someGlobalVar global.
 * @global array $someGlobalVar User defined array that bla bla bla.
 * @return mixed Return a result bla bla bla.
 */

Ben phpDocumentor sözdizimini kullanın kaynak kodunda NetBeans IDE görüntü inline yardım böylece. Pekala NetBeans görünüyor ama ben bunu yapmak için bir yol olduğundan emin değilim ...

Herkes tamam teyit edebilir?

2 Cevap

$ SomeGlobalVar yana kullanıcı tanımlı ve bazı araştırma sonra ben @uses bu belgelemek için en uygun yol olduğunu düşünüyorum:

@uses $someGlobalVar User defined array that bla bla bla.

Belgeleri:

The @uses tag may be used to document any element (global variable, include, page, class, function, define, method, variable)

Ben inanıyorum bu tanımlanan değişken, örneğin belge olur

/**
 * My var
 * @var array
 */
$someGlobalVar = array();

Eğer API belge ve işlevselliği gibi sınıf yöntemi içinde bunu belgelemek gerekmez.

Zaten Benim görüşüm.

etiketler