20
L'Objective C ha un framework di documentazione simile a JavaDoc in cui la documentazione può essere generata dal codice sorgente?Framework di documentazione come JavaDoc per Objective C
A
risposta
15
Doxygen! Si può usare per molte lingue, tra cui Objective-C
+2
Sicuramente l'opzione migliore. Se vuoi andare ancora oltre, ho scritto uno script che convertirà l'output di Doxygen in modo che assomigli più ai documenti API di Apple: http://github.com/mattball/doxyclean –
6
Doxygen è abbastanza popolare tra gli sviluppatori Obj-C.
3
Si potrebbe avere uno sguardo a HeaderDoc Quale è il quadro di documentazione mela simile a Java.
1
Appledoc è diventato molto popolare. . . la versione 1 era basata su Doxygen, mentre la versione 2 era scritta da zero.
Non ha tutte le funzionalità di Doxygen (grafici, enumerazioni, classi C++, ecc.), Ma ciò che offre sono documenti magnificamente formattati in formato HTML di IDE integrato.
anche interessante notare è la seguente:
- Lo strumento CocoaPods comprende la documentazione Appledoc per le librerie che installa. Abbastanza utile.
10
Buone notizie per tutti! : D Finalmente dopo aver atteso a lungo Apple ha introdotto un commento parser per i nostri progetti. Secondo il new features in XCode 5:
Documentazione del progetto da documentazione di riferimento API quadro e commenti strutturati nel codice sorgente propria vengono visualizzate nel pannello di aiuto rapido e in codice viste completamento popover. Doxygen e HeaderDoc commenti strutturati sono formati supportati.
e dalle note di rilascio Clang 3.2:
Clang analizza i commenti e in grado di rilevare gli errori sintattici e semantici nei commenti. Questi avvisi sono disattivati per impostazione predefinita. Passare-Documentazione per abilitare gli avvisi sui commenti della documentazione.
Se volete vedere un esempio di questa nuova funzionalità vi consiglio di dare un'occhiata al seguente articolo: Documentation in Xcode 5
Non esiste uno specifico per Objective-C, ma io uso Doxygen. Apple usa HeaderDoc, ma praticamente nessun altro lo fa più. –