ActionScript 2 için, ben kullandım NaturalDocs. Ancak PHP için oldukça kötü bir desteği vardır. I Doxygen ve phpDocumentor şu ana kadar baktım, ancak çıkış bence çok çirkin. Herkes PHP için otomatik dökümantasyon nesil ile herhangi bir deneyimi var mı? Ben javadoc tarzı etiketler kullanabilirsiniz edebilmek için tercih ediyorum, onlar yazmak için kısa ve hatırlanması kolay.
Bilgilendirme kısmı API doc üretebilirsiniz iki iyi bilinen ve sıklıkla kullanılan bir araç vardır:
About the "guidelines" : I would say it depends on your projects, but, at least, I would expect to see :
@param type name description of the parameter@return type description of the return value@throws type description of the exception that can be thrownHarika bir şey olmaktan son IDE (like Eclipse PDT, örneğin) o , sen ;-) kodlama yaparken ipuçları sağlamak için, bu belirteçler okuyabilir ve yorumlayabilir
Also, there are more and more PHP tools that use php docblocks for some other purpose than documentation.
Bkz Annotations - Örneğin, PHPUnit bazı özel etiketler kullanarak bazı test ile ilgili şeyler belirlemenizi sağlar.
ApiGen belgeler, standart sınıfları ve genel belgeleri, vurgulanan kaynak kodun oluşturulmasını ve PHP 5.4 özellikleri için deneysel destek PHP çapraz referans arasındaki bağlantı, PHP 5.3 ad alanları, paketleri için desteği vardır.
http://www.docblox-project.org/
Tüm boyutları ve Sürekli Entegrasyon projeleri hedefleyen PHP 5.3 uyumlu API Belgeleri jeneratör.
tamamen ayrıştırmak ve Zend Framework 2 dönüşümü mümkün
PHPDoc Eğer yorum Javadoc tarzı inline açısından bakarım muhtemelen kadar iyidir. Ayrıca PHPXRef bakmak isteyebilirsiniz.
Evet, phpDocumentor (http://www.phpdoc.org/) PHP autodocs için kabul edilebilir bir standart araçtır. Bu de-facto standart.
Bu PHP kodu belgeleyen zaman kodu için genel Javadoc kurallara uymayı kabul edilebilir. Ancak, PHP ve Java farklı dil, çünkü bu yeterli değil durumlarda içine çalıştırmak için gidiyoruz.
Örneğin, PHP fonksiyonları dönüş türü var ve bu bir bağlam ile bir tür geri dönmek için bir işlev için kaçınılmaz (ve bazen arzu), ve ikinci bir bağlamda başka bir türü. Java ile yapmak imkansız çünkü Javadoc kurallar, bu konuda yardım edecek değildir.
Wordpress kod tabanı phpdoc etiketleri kullanarak belgelenmiştir (this) ve genellikle oldukça iyi - bu here phpDocumentor kullanarak render ediyor.
Bunu ben. Net yapılır için docs autogenerating düşünmek gerekir ki yeterince önemli yazmaya kod çoğu, bu yüzden olsa bir dokümantasyon yazarın bakış açısından çok veremez
PHPDoctor http://peej.github.com/phpdoctor/, PHP için basit ama tam özellikleri Javadoc klon göz atın.
Çirkin bir sorun varsa, ben sadece bir özel biri için stil açın ediyorum. Eğer oluşturulan bir üzerine yazmak istemiyorsanız, size Stylish gibi bir Firefox eklentisi kullanabilirsiniz.