2012-08-29 19 views
10

¿Existe alguna herramienta para documentar los muchos enlaces de Xcode, los enlaces de salida y IBAction, los enlaces de valores clave, etc.? He visto los hilos en Doxygen y HeaderDoc, pero estos archivos de programas de documentos, para describir las clases, etc., pero no parecen abarcar la gran cantidad de enlaces 'ocultos' que Xcode arrastra y suelta?Auto documentación de Xcode y XIB

Un ejemplo específico, puedo usar el editor XIB para crear un IBAction para cada control en mi ventana, para métodos en una o más clases/instancias, definidas en uno o más archivos - Quiero UNA lista de todos estos , mostrando el tipo y nombre de control, el archivo fuente, la clase y el método, o una representación gráfica sería incluso mejor. A continuación, una lista similar para la ruta del valor clave se vincula a arrayControllers, etc.

SOY nuevo, así que si me he perdido algo obvio, por favor dígame.

Gracias.

Respuesta

4

No, no hay ninguna herramienta para documentar archivos .xib a menos que considere el archivo como parte de su documentación. (Después de todo, dices "autoeducación") .xibs se almacenan como XML, por lo que si realmente quieres extraer los datos, está ahí para tenerlos.

Las acciones que crea en IB aparecen en su código fuente. Podría agregar comentarios allí describiendo el objeto que envía la acción, pero eso en gran medida se perderá el punto de usar un .xib (y acciones) en primer lugar, que es desacoplar los elementos de la interfaz de usuario del controlador.

Si el objetivo de la documentación es hacer que su proyecto sea más fácil de entender para otros desarrolladores, es posible que desee obtener algo más de experiencia con Objective-C antes de tener problemas para crear una herramienta de documentación .xib. Dado un .xib y los archivos de encabezado relevantes, cualquier programador de Obj-C competente debería ser capaz de decir fácilmente qué controles están conectados a qué acciones, o para solucionar problemas en esa área. Las personas han estado trabajando con archivos .xib y .nib durante más de 20 años. La falta de una herramienta de documentación independiente puede ser una buena indicación de que tal cosa puede no ser tan útil como parece al principio.

Cuestiones relacionadas