yorumladı kodunu tamamlamak için phpdoc Eğitimi / Genişletilmiş sayfaları oluşturmak için nasıl

4 Cevap php

Ben bana oluşturur belgelerine ek DocBook öğretici biçimi kullanmak için izin phpDocumentor almak için elimden geleni çalışıyorum:

  1. Eclipse kullanıyorum
  2. Ben bir OSX makinede ARMUT yoluyla phpDocumentor yükledim
  3. Benim php sınıflardan kod ben çalıştırabilir ve otomatik oluşturmak
  4. Bu Öğreticiler biçimlendirmek değil - ben bir çözüm bulamıyorum

. Ben kodu içinde başvurulan ediliyor paketine benzer bir ad kullanarak alt klasörlerdeki tüm dosya yapısı üzerinde pkg örnek dosya taşıma denedim .. Ben bir kayıp gerçekten kulüpler - onlar koyun NEREDE birisi açıklamak, . onlar belgeleyen ve bunu biçimlendirmek PHPDoc tetiklemek nasıl ben bunu takdir ediyorum koduna göre PKG ve diğer DocBook dosyaları, ben şu anda bu kullanıyorum:

phpdoc -o HTML:Smarty:HandS
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/"
-t /path/to/output

4 Cevap

Benim kendi soruya cevap beklemiyorduk, ama deneme ağrı ve bir hafta sonu bükme aklın 2 gün sonra bu sorun görünüyor:

Öğretici ve benim örnekler çalışır, ama there seems to be a minor flaw in the way phpdoc interprets the switch values gerekir. İşte kullanarak oldum ne:

phpdoc -o HTML:Smarty:HandS
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/"
-t /path/to/output

Aşağıdaki kullanabilirsiniz ancak eğer:

    phpdoc -o HTML:Smarty:HandS 
-d /path/to/code/classes/, /path/to/code/docs/tutorials/
-t /path/to/output

Bu doğru öğreticiler ve uzanan docs biçimlendirir, tüm yaptım oldu drop the double quotes dizin yollarını çevreleyen. ... Bu phpdoc bir hata gibi görünüyor ve aynı davranış web tabanlı arayüzü ile oluştu hiçbir boşluk varsa phpdoc gibi kendisi çift tırnak dizinleri sarar, böylece onun bir iç - Tek tırnak hiç çalışmıyor sorunu. benim orijinal girişimi çalışmış olmalıdır ama geliştiriciler temas ve onların dikkatine getirecek vermedi.

Sorun çözüldü.

Okuduğunuz this?

Bu aşağıdaki yolu düzeni önermek: tutorials/package/package.pkg burada paketi, paket adıdır bunu bu şekilde yaptın?

Evet, çift tırnak, kullanım muhtemelen / "/ yol / / kod / docs dahil olmadan, bir parametre / değer çifti olmak" / yol / / kod / sınıflar-d "neden phpDocumentor iç zamanı argümanı ayrıştırma attı ek bir dizin değeri olarak öğreticiler ".

Tipik olarak, ben yaratılıyor değil öğreticiler etrafında iki diğer sorunları gördüm. Bir, öğretici dizin phpDocumentor beklediği değildir. İki, hiçbir gerçek PHP kodu dosya yürütme dahildir. Ben özellikle bu iki senaryo için kılavuza şişirme ekleyerek hatırlıyorum [1].

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial%5Ftutorials.pkg.html#howto.location

Ben yapılandırması için bir. Ini kullanarak aynı sorunu yaşıyor, ama bana sorun ben dizinde-d parametresine 'bağlantılı' olmama sonuçlandı virgül ve dizinde arasında bir boşluk koymak oldu.

Çalışmıyor:

directory = {$lib}/Question,{$lib}/Error, {$path}/docs/tutorials

Çalışma:

directory = {$lib}/Question,{$lib}/Error,{$path}/docs/tutorials

Bu başkası için sorunu çözer umut!

etiketler