Benim işyeri belgelerine nesil bir çözüm uygulamak gerek ve üç başlıkta yer daralmış. Ben olması bulmak çok az bilgi yoluna resmiyet arasında karşılaştırmalar Bu çözümleri, ve umut ediyorum ki bu deneyimini bir veya daha yukarıdaki bir aday

Benim ilk pass toplamak mümkün olmuştur:

HeaderDoc Artıları: Apple'ın mevcut dokümanlar, apple docsets yapma ile uyumluluk gösteriyor
HeaderDoc Eksileri: davranış değiştirmek Zor, proje aktif olarak çalışmış, pek çok şey (bir şey eksik olmalı, bunu ölçmek edemiyorum ama anlamı) uzak değiştirmiş.

Doxygen Artıları: Aktif destek geniş kullanım topluluk b/c Bankası, özelleştirilebilir, en çıkış türleri (lateks vs. gibi)
Doxygen Eksileri: İş/elma docs ile tutarlı davrandığını göstermek için alır, apple docsets ile uyumluluk gibi kolay değil

AppleDoc Artıları: Görünüyor Apple'ın mevcut dokümanlar, apple docsets yapma ile uyumluluk gösteriyor
AppleDoc Eksileri: Typedefs, çeteleler ve işlevleri belgelerine, aktif olarak geliştirilmekte olan sorun

Bu doğru mu? İstenen çözümümüz var

• Tutarlı bir görünüm ve elma ile objective-c sınıfı başvurusu
• -Tıklama seçeneği Güncellemelerinden içinde belgeleri başvuru çekin, ve daha sonra doktor bağlamak için yeteneği (sadece Apple'ın sınıflar gibi)
• Kategori akıllı işleme uzantıları ve bunun gibi Apple'ın sınıfların bile özel kategoriler)
• Yeteneği oluşturmak için kendi referans sayfa (Bu sayfa: Yükleniyor... o görüntüleri vardır, ve bağlantılı olarak oluşturulan sınıf başvuruları sorunsuz bir şekilde nasıl Apple'ın UİViewController sınıf referans bağlantıları, bağlı sayfa.
• Kolay inşa komut entegre edilebilir bir komut satırı komutları çalıştırmak için
• Çok büyük kod temeli zarif işleme

Yukarıdaki bütün bilgilere dayanarak, yukarıdaki çözümleri açıkça diğerlerinden daha iyi? Ya da eklemek için herhangi bir öneri bilgi son derece mutluluk duyacağız.

Ben yazarın appledoc, bu cevap olabilir önyargılı :) denedim bahsi geçen tüm jeneratörler olsa (ve daha fazla) ama gerek yok sinirli olarak üretilen sonuçları istedim (benzer hedefleri olarak).

Puan (sadece headerdoc o kadar iyi hatırlamıyorum appledoc ve doxygen söz) göre:

1. Tutarlı bakış: kutu, css, ama muhtemelen yapılabilir. tweak diğer ihtiyaç appledoc

2. Belgeleri setleri nesil (Güncellemelerinden başvurular için): xml oluşturur doxygen kutusu, aranabilir ve seçeneği tıklanabilir belgeler için tam destek appledoc ve kendinize çağırmak için ihtiyacınız olan makefile. Ayrıca appledoc destekler kutu published docsets.

3. Appledoc 1 ** bilinen sınıfları için ya da onları ayrı bırakmak ayrı index file listelenen Vakfı. kategori: doxygen: bu ben denedim. en iyi çalışma değildi

4. Özel referans sayfaları: supports kutu ya fiyat indirimi ya da özel html kullanarak dışarı appledoc doxygen: ana sayfa için özel belgeleri de dahil edebilirsiniz, eğer daha fazla sayfa içerebilir bilmiyorum.

5. Kolay komut satırı: bağlı size nasıl bakıyor: appledoc alabilir, tüm değişkenleri ile komut satırı anahtarları (aynı zamanda destekler isteğe bağlı global ve proje ayarları plist dosyaları) dolayısıyla çok kolay entegre ile komut dosyaları oluşturmak. doxygen tüm parametreleri Kur yapılandırma dosyası kullanımı gerektiriyor.

6. Büyük olarak kullanılabilecek kod temeli: Tüm araçlar timewise karşılaştırın yoktu, ancak bu desteği gerekir. Emin eğer herhangi bir aracı önbelleğe alınan değerler (biraz zaman kazanmak için daha önce toplanan verileri üzerinde çalışan) destekliyorsa da değil - bir sonraki büyük sürümü için bu ekleme araştırıyorum.

Diğer araçları kullanarak çalıştı beri bir süre oldu, doxygen/headerdoc ile yukarıda belirtilen konuları ele olabilir! appledoc kendisi de dezavantajları vardır: gibi söz yok destek için çeteleler, yapılar, fonksiyonlar vb (biraz işin bu yönü, check this fork), ve kendi set of issues Mayıs önlemek kullanarak, gereksinimlerinize göre.

Şu anda 6**, çeteleler desteği de dahil olmak üzere, yapı vb büyük bir güncelleme üzerinde çalışıyorum. Düzenli olarak deneysel şube için yeni şeyler daha büyük parçaları tamamlamak ve ilerleme takip edebilirsiniz böylece yeterince kararlı olun, en kısa sürede zorluyorum. Ama hala çok erken olduğunu ve ilerleme çözüm çalışmak kadar uzunca bir süre alabilir bu yüzden zamanımı bağlıdır.