Otomatik PHP Belgeleri Generator [kapalı]

3 Cevap php

Yerine jeneratör gibi olmak biçimi ihtiyacı neye göre yorum yazma - Ben aslında kaynak kodu okumak ve belgeleri oluşturmak PHP için herhangi bir belge jeneratör bakıyorum.

Ben phpDocumentor baktım ve birkaç diğer belgeler jeneratörler: tüm kaynak koduna bir yorum yazma ihtiyacı gerektirir.

3 Cevap

PHP Documentor aslında etiketleri veya bilgilendirme kısmı herhangi olmadan kod minimum dokümantasyon oluşturmak gerekir.

Eğer kodu hakkında güzel meta-bilgi ve ayrıca belgelerin makul bir stil çok almak istiyorsanız Ancak, o zaman gerçekten kodunuzu tanımlamak için bilgilendirme kısmı ve etiketleri kullanarak olmalıdır ...

Update

PHP Documentor artık bir proje olarak korunur - ama DocBlox şimdi var. PHP Documentor (PHPDoc) orijinal sözdizimi bir yeri vardır, ama aynı zamanda çok, PHP 5.3 'ten özellikleri ve sözdizimini destekler ve rapor şablonu / dekorasyon özelliklerini uygulamak için daha kolay gibi görünüyor.

i phpDocumentor ile dertte ama hiçbir şey yoktu, ama http://www.apigen.org kuralları! PhpStorm sizin için phpdoc büyük bir kısmını oluşturur.

Doxygen yapılandırması EXTRACT_ALL = YES ve EXTRACT_PRIVATE = YES ile ve tamam olmalıdır kullanın. Size yalnız fonksiyonu / yöntemi / sınıf imzalar elde edilemeyen bir şey söyler çünkü Açıkçası, böyle bir dokümantasyon çok iyi değil. Bu yeterli değilse, belgeler var.

Ben herhangi bir kod için böyle bir belge almak olsaydı Ancak, aksi takdirde ben kodu / kütüphanesi kullanmaya çalışırsanız yapmak için çok fazla varsayım var çünkü, çok, gerçek kod olmasını istiyorum.