Come creare documentazione per variabili e metodi di istanza in Xcode?

Question

Mi piacerebbe essere in grado di Alt-Click una variabile di istanza (o un metodo) come parte del programma che ho creato e leggere quale sia lo scopo.

Il fatto che Xcode indichi che la variabile di classe è dichiarata su - è buona ma non sufficiente. In questo caso mi piacerebbe vedere il testo personalizzato che ho digitato per descrivere cosa sia veramente un asset. Inoltre, sarebbe utile conoscere anche il tipo di ivar.

Come si può fare? In questo caso, mi chiedo che cosa esattamente mi voglio dire con assets

io in particolare chiedo se queste informazioni possono essere visualizzate da dentro Xcode, simile a come Eclipse mostra JavaDoc contenuti.

Answer 1

Si avrebbe bisogno di creare un set di documentazione per il vostro progetto e installarlo in Xcode. appledoc può aiutarti con questo. Questo è uno strumento da riga di comando che può generare documentazione nello stile di Apple da commenti appositamente formattati nelle intestazioni. È inoltre possibile integrarlo nel processo di compilazione con una fase di esecuzione dello script, in modo che la documentazione sia sempre aggiornata.

per i piccoli progetti, non è di solito vale la pena e anche se probabilmente stai meglio solo l'aggiunta di commenti ai file di intestazione e saltare lì con Cmd-clic (Ctrl + Cmd + freccia sinistra per tornare al punto in cui si venire da).

Answer 2

Probabilmente vorrai dare un'occhiata alla documentazione di Apple su Documentation Sets e sul loro articolo su generating doc sets using Doxygen. Quest'ultimo si basa su Xcode 3.x, quindi quanto è pertinente è alquanto discutibile, ma sarebbe comunque una buona idea dare un'occhiata.

Detto questo, se decidi di utilizzare Doxygen (alternative come HeaderDoc possono essere utilizzate per la documentazione, ma non sono sicuro di ciò che è a tua disposizione per quanto riguarda la creazione di set di documenti), sembra che il punto principale sei tu Vorresti lanciare GENERATE_DOCSET=YES nel tuo Doxyfile (o in qualunque modo tu decida di chiamarlo). Dopo di ciò, devi semplicemente inserire i risultati in ~/Library/Developer/Shared/Documentation/DocSets (in base alla documentazione di Doxygen). Non so se funziona su Xcode 4.x - vale comunque la pena provarlo, e sarebbe bello ascoltarlo.

Nota: la maggior parte si basava su this answer di Barry Wark. Il credito delle figure è dovuto lì, dato che non mi sarei preso la briga di indagare su questo se non fosse stato per la sua risposta.