¿Existe un generador de documentación generalmente aceptado para Objective-C (similar a RDoc para Ruby)? He visto Doxygen y ObjcDoc, y me pregunto cuál es el más utilizado.Documentación-generador para Objective-C?
Doxygen es probablemente la opción más utilizada. Debido a que no es solo para ObjC (Doxygen es compatible con muchos otros idiomas), el desarrollo es animado y la comunidad bastante fuerte. HeaderDoc (ahora un proyecto de fuente abierta), en comparación parece haberse estancado en gran medida. HeaderDoc solo produce resultados HTML, mientras que Doxygen también produce PDF, LaTeX y muchas otras formas de salida además de HTML. Incluso Apple parece recomendar Doxygen, con la guía this para producir automáticamente juegos de documentación, compatibles con el visor de ayuda de Xcode, desde el proceso de creación de Xcode.
Vale la pena señalar que Doxygen puede leer los comentarios del estilo HeaderDoc, para que pueda escribir su documentación en estilo HeaderDoc y decidir luego si desea producir el resultado final usando Doxygen o HeaderDoc.
Doxygen es muy utilizado. Parece que también lo uso como una respuesta SO una vez a la semana.
Además de doxygen, apple tiene una herramienta que viene con las herramientas de desarrollo. Genera el tipo de documentación que ve en cosas como el marco SystenConfiguration. La herramienta se llama HeaderDoc y la documentación se puede encontrar en el HeaderDoc User Guide.
El desarrollo de HeaderDoc está bastante estancado. Doxygen es una opción mucho mejor. Con complementos apropiados, la salida de Doxygen puede verse muy similar a HeaderDoc si esa es su preferencia. –
Stagnant o no, es una opción válida para generar documentación para Objective-C/C/C++. Personalmente odio la documentación que genera Doxygen. –
¡Sí, eso es lo que estaba buscando! Si está codificando con Xcode en una Mac, ¿por qué no usar las cosas que Apple usa de todos modos? – Nils
Echa un vistazo appledoc. Se basa en Doxygen. Puede ver que come su propia comida para perros en el sentido de que genera el appledoc reference documentation para el appledoc source code. Compare, por ejemplo, GBComment.h con GBComment Class Reference.
También, echar un vistazo a Xcode's Documentation Set Guide para obtener instrucciones completas sobre cómo crear documentación que trabaja con Xcode. Estas son las instrucciones que Appledoc automatiza.
Recientemente hemos cambiado de Doxygen a Appledoc, y estoy muy feliz de que Ahora, lo mejor de IMO es que las burbujas de ayuda emergentes rápidas (opción-clic) tienen la misma información que obtienes para los documentos de Apple. Los documentos doxigen generados no tienen la estructura correcta para ser recogidos por ellos. – DougW
Comentando que las dos guías que ha vinculado se han movido a [aquí para escribir comentarios] (http://gentlebytes.com/appledoc-docs-comments/) y [aquí para ver ejemplos de configuración de línea de comandos] (http: // gentlebytes.com/appledoc-docs-settings/). –
Nota: Appledoc 2 ya no se basa en Doxygen –
Quizás debería probar jazzy por Realm. Es un proyecto de código abierto. jazzy admite ambos Objective-C & Swift.
"El resultado coincide con la apariencia de la documentación de referencia oficial de Apple, después de WWDC 2014". Que puedes juzgar desde el sample doc que proporciona.
[ACTUALIZACIÓN] (http://stackoverflow.com/questions/813529/documentation-generator-for-objective-c/6487090#6487090): appledoc es la solución nueva y mejorada. "[Usa] doxygen como base para extraer la documentación de los archivos fuente y luego convierte la salida doxygen en un diseño de aspecto más agradable." – ma11hew28
appledoc es problemático, requiere que usted lo atribuya en su documentación o en su sitio web que utilizó appledoc. ¿Desde cuándo un formateador requiere atribución?!? –