php + doxygen

[vigo]

arkadaşlar,
php dökümantasyonu için doxygen kullanan varmı?

varsa;

class'ı nasıl dökümante ettiniz ?
@var kullanabildinizmi? , uml out alabildinizmi? full detaylı comment yapabildinizmi? property leri myClass::hede değilde myClass->hede şeklinde gösterebildiniz mi?

qt stili dışında...

( lütfen diğer dökümnaterler ile ilgili reply yapmayın | phpdoc vs... )

teşekkürler...

[nightlord]

c++ ile kullanmistim ama php ile ilgili fikrim yok. ve de "vaay uml ciktisi da verebiliyor" diye saskinligimi da belirteyim

[skate]

Vigo PHP ile kullanmıştım ve tüm dediklerin yapılabiliyor. Biraz inceliim, config dosyasında neler ayarlaman gerektiğini söylerim.

[skate]

Doxygen kullandığım projenin eski bir kopyası varmış şirketteki HDD'de. Birşey hatırladım. Herşeyi Class/Method ya da Function şeklinde kullanmak gerekiyordu Doxygen ile düzgün bir output alabilmek için. Application diye bir class yapıp herşeyi içine gömmüşüm ben. Eğer classların ya da functionların dışında kalan kodların varsa onları atlıyordu Doxygen. Ancak benim kullandığım versiyon 1.5.1miydi neydi (yoksa 1.4.x miydi tam hatırlamıyorum). 1.5.4'e kadar birşeyler eklemişlerse bilemeyeceğim.
 
Doxygen'in config dosyası yok burada. Ancak dummy bir proje deneyebilir ya da eşimi arayıp evdeki makinemde buldurabilirim örneği.

[vigo]

valla örnek süper olur;
şunu mesela;

Kod: [Seç]

class myClass
{
   
    var $testItem1;
    private $testItem2 = array();
    protected $testID;

    function __construct( $id = -1 )
    {
        $this->testID = $id;
        $this->$testItem2[] = $this->testID;
        $this->Init();
    }

    function __destruct()
    {
        $this->$testItem2 = null;
    }

    private function Init()
    {
        return 'ok';
    }
}


örneğin __construct( $id ) 'de $id nin integer olarak geçilmesi gerektiğini nasıl belirtirim gibi... yani bu class'ı adam gibi tüm memberları ile, method'ları vs nasıl comment ederim gibi bi örnek varsa süper olur

[endo]

Doxygen kullanmadim hic ama php'de tum degiskenler tipleri run-time'da belirleniyor,
yani (int) $x gibi birsey veremiyorsun. (verirsen de run-time'da casting yapmis oluyorsun)
$x ille de int olsun diyeceksen yine runtime'da settype($x, "int") diyorsun.. tabii yine runtime oldugundan doxygen bunu da gormeyecektir.
diger konulari doxygen kullanmadigimdan bilemiyorum..

[skate]

Vigo, şimdi evdeyim birazdan bir göz atıcam o eski projeme. Ama Endo doğru söylüyor. Doxygen PHP'nin class yapısını v.s. çıkarır ancak değişken türlerini gösteremez. Çünkü PHP'de değişken türü diye birşey yok. Endo'nun dediği gibi run-time'da belirleniyor ve en büyük özellikleri bir kere belirlendikten sonra da run-time'da dinamik olarak değişebilmesi.
 

Kod: [Seç]

<?php
 $x = &quot;1.4&quot;;
 echo $x/1.7;
?>Bu kodun çıktısı:
0.82352941176471
 
oluyor. Yani başta kesin olarak string bile tanımlamış olsan anında float, double türü bir değişkene cast edilebiliyor otomatik olarak. Kısacası sen bir fonksiyonun parametresine "integer" diyemiyorsun. Ama yine de 8 farklı tip değişken belirlenmiş PHP'de.
 
Doxygen elbette ki PHP, Perl gibi dillere kısmen destek veriyor. Ancak yapıyı görmek açısından oldukça faydalı PHP projeleri için de.

[skate]

Benim kullandığım örnek config ekteki dosya idi. Proje ismini falan dummy yaptım sadece. PHP için özel ayarlar yok, ben sadece output'u istediğim gibi ayarlamıştım. php.cfg'yi proje pathine kopyaladıktan sonra command propmtdan o pathe gidip "doxygen php.cfg" ile dökümantasyon üretilebilir doğrudan. doxygen'in pathini env. variables'a eklediğinizi varsayıyorum.
 
Aslında ekteki dosyada çok bir marifet yok. Önemli olan kodu doxygen'e uygun hazırlayabilmek. Benim birçok PHP projem bu config dosyasıyla çok kötü sonuç veriyor mesela. Ancak düzenli OOP hazırladığım projelerim için faydalı oluyor.

[vigo]

ok saolun... yanlız beni ikinizde yanlış anlamışsınız... amacım comment ederken bu verinin tipini belirtmekti...

/**
*@class myClass
*
*/

/**
*@var $armut integer
*/

var $armut;

tarzı bi commenting... yapmış adamlar gördüm ama source u göremediim için içinden çıkamadım...

doxygen derki \var ( yada @var aynı şey ) \fn ve \typedef le ayndır...

ama düşünmemişki, ben c++ cı diilim, qt nedir bilmem, c func, c++ func anlamam....


bi şekilde @class ile bi tür grup define edip, o member'ın o grubun memberı olduunu filan comment etmek lazım...

[endo]

hmm.. doxygen bilmiyorum demistim ya, harbiden bilmiyormusum
ben tanimlamalara bakiyor saniyordum..

[nightlord]

doxygen'in phpde ne yaptigini bilmiyorum ama c ve c++'da tanimlamalara da bakiyor commentlere de

[vigo]

gördüüm en süper api-doc yapma tool'u... ama normal olarak abiler c,c++,java ya uygun geliştirmiş, neticede php'de c türevi gibi bişi olduu için "yerse" hesabı olmuş... 3-4 gün boyunca google'da, heryerde aradım. örnek bi tana php comment out bulamadım... yani neticede 1-2 trick ile istediini generate ettiriyorsun... keza phpdoc ile 1-1 uyumlu da diil... önümüzdeki günlerde umarım güzel bitane bulurum...

bir rica, i18n ye uygun çalışıyor. eleman readme'de istediin dil'i ( şuan varolmayan ise ) nası ekliceni anlatmış... sanırım compile etmek lazım tekrar... anlayan biri varsa bi bakıverse, türkçe olarak api-doc süper olur işime yarar... en azından bana bi dictionary list gibi bişi verseniz ben üşenmeden için doldururum.. birileri bi incelermi ? ( belki bu birisi nightlord mu acaba ( : )

yani müsait olanlar ...

[nightlord]

tamam abi tabi ki bakarim. yalniz belki hazir bulmamiz mumkun olabilir. ozellikle pardus ekibi bu isi hali hazirda yapmis olabilir diye dusunuyorum

[vigo]

inşallah hazırı vardır... süper olur...