Doxygen vs Javadoc

SORU

22 EKİM 2008, ÇARŞAMBA

Doxygen vs Javadoc

Ben Doxygen Java (ve diğer diller) ile de çalışan adı verilir bir makaleden olmuştur. Ama Java zaten Javadoc aracı vardır. Birisi ya da yaklaşımın artıları ve eksileri nelerdir açıklayabilir mi? Bunlar birbirinden ayrı mıdır? Doxygen için bir Maven eklentisi var mı?

CEVAP

27 Kasım 2008, PERŞEMBE

Doxygen bir dizi özellik vardır bu JavaDoc etmez, örn., sınıf diyagramları için hiyerarşileri ve işbirliği kapsamında, daha Özet sayfaları, isteğe bağlı kaynak kodu tarama (çapraz bağlantılı olan belgelere), ek etiket desteği gibi @yapılacaklar konusunda ayrı bir sayfa ve üretir çıktı TeX ve PDF formatında.Ayrıca görsel Özelleştirme Bir sürü sağlar.

Doxygen standart JavaDoc etiketleri destekler, çünkü JavaDoc yorumlar ile herhangi bir kaynak kodu Doxygen çalıştırabilirsiniz. Çoğu zaman bile diyagramları ve kaynak kodu tarama bile belgeleri olmadan kod anlama yardımcı olduğundan, bu anlamda JavaDoc olmadan kaynak kodu çalıştırmak için yapabilirsiniz. Ve JavaDoc aracı bilinmeyen etiketler yok sayar bu yana bile JavaDoc nesil bozmadan ek Doxygen etiketleri kullanabilirsiniz.

Bütün bunları söyledikten sonra, uzun bir süre için Doxygen kullanmadım itiraf etmeliyim. Meyilli bir güvenin ağır benim IDE bugünlerde sağlamak aynı görselleştirme ve ben genelde okumam JavaDoc HTML olarak sayfaları ama al kaynak dosyaları içine benim IDE bu yüzden üretir JavaDoc flyouts ve ben atlamak için tanımlar. Bu Doxygen verebileceklerinden daha güçlü. IDE dışında belgelerine sahip olmak istiyorum ve non-Java takım çalıştırmak için mutluyuz sonra Doxygen Java kodu için herhangi bir değişiklik gerektirmez ama denemeye değer.

Bunu Paylaş: