it-swarm.com.de

Dokumentationsgenerator für Objective-C?

Gibt es einen allgemein akzeptierten Dokumentationsgenerator für Objective-C (ähnlich wie RDoc für Ruby)? Ich habe Doxygen und ObjcDoc gesehen und frage mich, welche am häufigsten verwendet werden.

48
Stephen Touset

Doxygen ist wahrscheinlich die am häufigsten verwendete Option. Da es nicht nur für ObjC (Doxygen unterstützt viele andere Sprachen) ist, ist die Entwicklung lebhaft und die Community ziemlich stark. HeaderDoc (jetzt ein Open Source-Projekt) scheint im Vergleich weitgehend stagniert zu haben. HeaderDoc erzeugt nur HTML-Ausgabe, während doxygen neben HTML auch PDF, LaTeX und viele andere Ausgabeformulare erzeugt. Sogar Apple scheint Doxygen zu empfehlen, mit this , um automatisch Dokumentationssätze zu erstellen, die mit dem Hilfeviewer von Xcode in Ihrem Xcode-Erstellungsprozess kompatibel sind. 

Beachten Sie, dass doxygen Kommentare im HeaderDoc-Stil lesen kann, sodass Sie Ihre Dokumentation im HeaderDoc-Stil schreiben und später entscheiden können, ob Sie die endgültige Ausgabe mit doxygen oder HeaderDoc erstellen.

54
Barry Wark

Check out appledoc . Es basiert auf Doxygen . Sie sehen, dass es sein eigenes Hundefutter frisst, indem es die Referenzdokumentation appledoc für den appledoc-Quellcode generiert. Vergleichen Sie beispielsweise GBComment.h mit GBComment Klassenreferenz .

In Xcode Documentation Set Guide finden Sie eine umfassende Anleitung zum Erstellen von Dokumentation, die mit Xcode funktioniert. Dies sind die Anweisungen, die appledoc automatisiert.

43
ma11hew28

Doxygen wird sehr häufig verwendet. Ich scheine es auch ungefähr einmal in der Woche als SO Antwort zu verwenden.

6
Charlie Martin

Ein neues Tool ist Jazzy von Realm, das Dokumentation im neuen Xcode 6-Stil generiert und die Erstellung von Swift-Dokumentation (sowie Objective-C) unterstützt.

5
James

Neben Doxygen verfügt Apple über ein Werkzeug, das mit den Entwicklungswerkzeugen geliefert wird. Es generiert die Art der Dokumentation, die Sie zum Beispiel beim SystenConfiguration-Framework sehen. Das Tool heißt HeaderDoc. Die Dokumentation finden Sie im HeaderDoc User Guide .

4
Jason Coco

Vielleicht solltest du jazzy von Realm versuchen. Es ist ein Open Source Projekt. jazzy unterstützt sowohl Objective-C als auch Swift. 

"Die Ausgabe entspricht dem Erscheinungsbild der offiziellen Referenzdokumentation von Apple nach der WWDC 2014." Was Sie aus dem sample doc beurteilen können, das es zur Verfügung stellt.

0
0xa6a