Benim çerçevesi ve uygulama için bir yerinde API başvurusu oluşturmak için arıyorum.

Temelde, bir sınıf dosyası var diyelim model.class.php:

class Model extends Object {

    ... code here ...

    // Separates results into pages.
    // Returns Paginator object.

    final public function paginate($perpage = 10) {

        ... more code here ...

    }

}

ve benim geliştiriciler fonksiyonları çağrılacak mevcut olduğu bilmek için hızla başvurabilirsiniz bir başvuru oluşturmak mümkün olmak istiyorum. Onlar sadece doğrudan her fonksiyonu ve beyan çizgi üstü yorumları görmek gerekir. (C + + başlık dosyasına benzer) böyle bir şey:

// Separates results into pages.
// Returns Paginator object.

final public function paginate($perpage = 10);

Ben biraz araştırma yaptım ve this answer Ben içeri yorum tutmak nasıl emin değilim, ancak, (Reflection sınıfları kullanarak) oldukça iyi baktım

Herhangi bir fikir?

EDIT: Üzgünüm, ama şimdiki comment biçimlendirmeyi tutmak istiyorum. Kendimi ve kod üzerinde çalışan insanlar phpDocumentor ile ilgili ayrıntı nefret ediyorum. Değil tüm projenin Yorum-yeniden yazmak söz yıllar alacağını, bu yüzden düz metin sadece / / yorumlarınız korumak istiyor.