PHP kodu otomatik dökümantasyon

2 Cevap php

Tamam ben phpDocumentor php kodu belgeler oluşturmak için var biliyorum. Bu uzun bir süre güncellenen henüz (ama belki de onun çoğunlukla özelliği tam rakam) görünüyor.

Bu diğer programcılar için bir şeyler belgelemek için iyi olabilir iken, bir web hizmeti dışsal "API" belgelemek için de uygun görünmüyor. Ben güzel bir MVC yapılandırılmış proje var eğer IE, phpDocumentor bu proje diğer geliştiriciler için tüm modelleri ve iç kütüphaneleri ve bu belgelemek için büyük olabilir, ama nasıl ben bunu sağlayan web hizmeti belgelemek mi?

Senin gibi etiketleri kullanarak denetleyicileri yöntemleri belge verebilecek şeyler düşünüyorum:

/**
 @service /device/add
 @access POST
 @return JSON 
*/

oluşturulan dokümanlar bir POST isteği yapmak gerektiğini gösteriyor hangi, o erişmek için JSON veri ve URL'sini döndürür http://whatever.com/device/add. Açıkçası taban url bu servis aramaları için ne tanımlayan belgeler için küresel bir yapılandırma dosyası olacaktır.

Bu noktada ben sadece phpdoc blokları (veya zeyilname kütüphane ile Açıklamalarıyla kullanarak) kullanarak yansıma şey kendimi uygulamak ve dinamik sağ uygulamada erişilebilir dokümanlar olacaktır düşünüyorum.

2 Cevap

Sen phpDocumentor doxygen (veya PHPxRef) tercih edebilirsiniz.

"Bir web hizmeti" API "Bu diğer programcıların şeyleri belgelemek için iyi olabilir iken, dış belgelenmesi için de uygun görünmüyor".

Neden dışarıdan görünür API işlevleri içine doxygen (ya da herneyse) yorum only koymak değil mi?

Her bir tanım vermek ve kullanımı @param [in], @param [out] ve @return.

İstediğin şeyi elde değil misiniz? Ya da ben bir şey mi kaçırdım?

Ben soran ((özellikle sığınakta ise) bir API belgeleyen) bir WadL kullanmak için ne olacağını düşünüyorum. Onun kaynağından elde edilecek (PHP bunun için herhangi bir alet) gitmiyorum verilmiş, ama bir WadL bir hizmet belgelenmesi için mükemmel.

Eğer ihtiyacınız gerçekten her şey - Sen ortam türleri, tüm yanıt kodları ve bunları nasıl idare her türlü numune yükleri olabilir.

etiketler