20
¿El Objective C tiene un marco de documentación similar a JavaDoc donde se puede generar documentación desde el código fuente?Marco de documentación como JavaDoc para Objective C
A
Respuesta
15
Doxygen! Se puede utilizar para muchos idiomas, incluido el Objetivo-c
+2
Definitivamente la mejor opción. Si desea ir más allá, he escrito un script que convertirá la salida de Doxygen para que se parezca más a los documentos API de Apple: http://github.com/mattball/doxyclean –
6
Doxygen es bastante popular entre los desarrolladores de Obj-C.
3
Se puede echar un vistazo a HeaderDoc cual es el marco documentación manzana similar a Java.
1
Appledoc se ha vuelto muy popular. . . la versión 1 se basó en Doxygen, mientras que la versión 2 se escribió desde cero.
No tiene todas las características de Doxygen (gráficos, enumeraciones, clases de C++, etc.), pero lo que sí ofrece es documentos bellamente formateados en HTML de formato integrado IDE.
También es interesante observar es la siguiente:
- La herramienta incluye documentación CocoaPods Appledoc para las bibliotecas que instala. Muy útil.
10
¡Buenas noticias para todos! : D Finalmente, después de esperar mucho tiempo, Apple ha presentado un comentario analizador para nuestros proyectos. De acuerdo con la new features en XCode 5:
documentación del Proyecto de documentación de referencia de API del marco y comentarios estructurados en su propio código fuente se muestran en el panel de ayuda rápida y en vistas Código de finalización popover. Los comentarios estructurados de Doxygen y HeaderDoc son compatibles.
y de las notas de liberación Clang 3.2:
Clang analiza los comentarios y puede detectar errores sintácticos y semánticos en los comentarios. Estas advertencias están desactivadas por defecto. Pase -Wdocumentation indicador para permitir advertencias sobre los comentarios de la documentación.
Si desea ver un ejemplo de esta nueva característica le recomiendo que eche un vistazo en el siguiente artículo: Documentation in Xcode 5
Cuestiones relacionadas
- 1. Documentación-generador para Objective-C?
- 2. Documentación similar a Javadoc para C++
- 3. ¿Documentación similar a Javadoc para bibliotecas C/C++?
- 4. Documentación de Javadoc para comentarios XML de C#
- 5. Javadoc para la documentación del proyecto
- 6. hibernación-como marco para C++
- 7. Marco de formulario de Objective-C
- 8. Importación de documentación de Javadoc en Eclipse
- 9. ¿Cómo generar documentación de javadoc con diéresis?
- 10. Cualquier marco de enlace XML para Objective-C?
- 11. Plantillas de documentación C++
- 12. Cómo hacer documentación con NetBeans y Javadoc
- 13. ¿Cómo decorar los métodos de Objective C con documentación?
- 14. C/C++ marco de prueba (como JUnit para java)
- 15. Documentación de código para delphi similar a javadoc o C# xml doc
- 16. Medición de la cobertura de documentación con Javadoc y Ant
- 17. JavaDoc: ¿dónde agregar notas/comentarios a la documentación?
- 18. Netbeans C/C++ JavaDoc código de finalización
- 19. Bloque de paso Objective-C como parámetro
- 20. Migración de Javadoc a la documentación de Python
- 21. C vs C++ (Objective-C vs Objective-C++) para iPhone
- 22. C/C++ Documentación del archivo de encabezado
- 23. Generador de documentación Visual studio C++
- 24. ¿Qué lenguaje/marco para HPC: Java/.Net/Delphi/C/C++/Objective-C?
- 25. Marco de modularización C++ (como OSGi)?
- 26. Resteasy - generar documentación REST desde Javadoc y anotaciones
- 27. Pelusa para Objective-C?
- 28. REPL para Objective-C
- 29. ¿Futuros para Objective-C?
- 30. Django como marco para Java
no hay uno específico para Objective-C, pero yo uso Doxygen. Apple usa HeaderDoc, pero prácticamente nadie más lo hace. –