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, welches am häufigsten verwendet wird.Dokumentationsgenerator für Objective-C?
Doxygen ist wahrscheinlich die am häufigsten verwendete Option. Weil es nicht nur für ObjC (Doxygen unterstützt viele andere Sprachen), ist die Entwicklung lebendig und die Gemeinde ziemlich stark. HeaderDoc (jetzt ein Open-Source-Projekt), scheint im Vergleich dazu weitgehend stagniert. HeaderDoc erzeugt nur HTML-Ausgaben, während Doxygen neben HTML auch PDF, LaTeX und viele andere Ausgabeformen erzeugt. Sogar Apple scheint Doxygen zu empfehlen, mit this Anleitung zur automatischen Erstellung von Dokumentationssätzen, die mit dem Xcode-Hilfe-Viewer kompatibel sind, aus Ihrem Xcode-Build-Prozess heraus.
Es ist erwähnenswert, dass Doxygen Kommentare im HeaderDoc-Stil lesen kann, so dass Sie Ihre Dokumentation im HeaderDoc-Stil schreiben und später entscheiden können, ob die endgültige Ausgabe mit Doxygen oder HeaderDoc erzeugt werden soll.
Doxygen ist sehr weit verbreitet. Ich scheine es auch einmal pro Woche als SO-Antwort zu benutzen.
Neben Doxygen hat Apple ein Werkzeug, das mit den Entwicklungswerkzeugen geliefert wird. Es generiert die Art der Dokumentation, die Sie beispielsweise in der Systemkonfiguration von SystenConfiguration sehen. Das Tool heißt HeaderDoc. Die Dokumentation finden Sie in der HeaderDoc User Guide.
HeaderDoc Entwicklung ist ziemlich stagnierend. Doxygen ist eine viel bessere Wahl. Mit geeigneten Add-ons kann die Doxygen-Ausgabe so gestaltet werden, dass sie HeaderDoc sehr ähnlich sieht, wenn Sie dies bevorzugen. –
Stagnant oder nicht, es ist eine gültige Option zum Generieren von Dokumentation für Objective-C/C/C++. Ich persönlich hasse die Dokumentation, die Doxygen generiert. –
Ja, das ist, was ich gesucht habe! Wenn Sie mit Xcode auf einem Mac codieren, warum nicht das Zeug verwenden, das Apple sowieso benutzt? – Nils
Auschecken appledoc. Es basiert auf . Sie können sehen, dass es sein eigenes Hundefutter isst, indem es das appledoc reference documentation für das appledoc source code erzeugt. Vergleichen Sie zum Beispiel GBComment.h mit GBComment Class Reference.
Werfen Sie auch einen Blick auf Xcode's Documentation Set Guide für eine umfassende Anleitung, wie Dokumentation erstellen, die mit Xcode funktioniert. Dies sind die Anweisungen, die appledoc automatisiert.
Wir sind vor kurzem von Doxygen nach Appledoc gewechselt, und ich bin sehr glücklich so Das Beste daran IMO ist, dass die schnellen Popup-Hilfe-Blasen (Option-Klick) alle die gleichen Informationen haben, die Sie für Apple-Dokumente erhalten. Doxygen generierte Dokumentsätze haben nicht die richtige Struktur, um von diesen abgeholt zu werden. – DougW
Kommentieren, dass die beiden Guides, die Sie verlinkt haben, nach [hier zum Schreiben von Kommentaren] (http://gentlebytes.com/appledoc-docs-comments/) und [hier für Beispiele von Befehlszeileneinstellungen] (http: // –
NB: Appledoc 2 basiert nicht mehr auf Doxygen –
Vielleicht sollten Sie versuchen jazzy von Realm. Es ist ein Open-Source-Projekt. unterstützt beide Objective-C & Swift.
"Die Ausgabe entspricht dem Look and Feel der offiziellen Referenzdokumentation von Apple nach der WWDC 2014." Das können Sie anhand der sample doc beurteilen.
[UPDATE] (http://stackoverflow.com/questions/813529/documentation-generator-for-objective-c/6487090#6487090): appledoc ist die neue und verbesserte Lösung. "[It] verwendet doxygen als Basis für das Extrahieren der Dokumentation aus Quelldateien und konvertiert dann die Doxygen-Ausgabe in ein schöner aussehendes Layout." – ma11hew28
appledoc ist problematisch - es erfordert, dass Sie es in Ihrer Dokumentation oder Ihrer Website, die Sie appledoc verwendet zuordnen. Seit wann benötigt ein Formatierer Zuordnung?!? –