Generatore di documentazione per Objective-C? [chiuso]

Question

Esiste un generatore di documentazione generalmente accettato per Objective-C (simile a RDoc per Ruby)? Ho visto Doxygen e ObjcDoc e mi chiedo quale sia il più usato.

Answer 1

Doxygen è probabilmente l'opzione più utilizzata. Perché non è solo per ObjC (doxygen supporta molte altre lingue), lo sviluppo è vivace e la comunità abbastanza forte. HeaderDoc (ora un progetto open source), al confronto sembra essersi ristagnato in gran parte . HeaderDoc produce solo output HTML, mentre doxygen produce anche PDF, LaTeX e molte altre forme di output oltre a HTML. Anche Apple sembra raccomandare doxygen, con questa guida a produzione automatica di set di documentazione, compatibile con il visualizzatore della guida di Xcode, all'interno del processo di creazione di Xcode.

Vale la pena notare che doxygen può leggere i commenti in stile HeaderDoc, quindi puoi scrivere la tua documentazione in stile HeaderDoc e decidere in seguito se produrre l'output finale usando doxygen o HeaderDoc.

Answer 2

Scopri appledoc . È basato su Doxygen . Puoi vedere che mangia il suo cibo per cani in quanto genera la documentazione di riferimento per appledoc per il codice sorgente appledoc . Confronta, ad esempio, GBComment.h a GBComment Riferimento classe .

• appledoc: come scrivere commenti
• esempi di appledoc delle impostazioni della riga di comando

Inoltre, dai un'occhiata a Guida al set di documentazione di Xcode per istruzioni complete su come creare documentazione che funzioni con Xcode. Queste sono le istruzioni automatizzate da appledoc.

Answer 3

Doxygen è molto usato. Mi sembra di usarlo come risposta SO anche una volta alla settimana.

Answer 4

Un nuovo strumento è Jazzy di Realm, che genera documentazione nel nuovo stile Xcode 6 e supporta generare documentazione Swift (oltre a Objective-C).

Answer 5

Oltre a doxygen, apple ha uno strumento fornito con gli strumenti di sviluppo. Genera il tipo di documentazione che vedi su cose come il framework SystenConfiguration. Lo strumento si chiama HeaderDoc, la documentazione è disponibile nell ' HeaderDoc User Guida .

Answer 6

Forse dovresti provare jazzy di Realm . È un progetto open source. jazzy supporta sia Objective-C & amp; Swift.

" L'output corrisponde all'aspetto grafico della documentazione ufficiale di riferimento di Apple, post WWDC 2014. " Che puoi giudicare dal documento di esempio che fornisce.