2010-03-19 20 views
10

Conozco Doxygen para generar la documentación. Lo que estoy buscando es una forma rápida de insertar documentación en Xcode similar a lo que hace Eclipse cuando edita archivos Java.¿Hay un complemento similar a Javadoc para Xcode que genera automáticamente la plantilla de documento?

Digamos que tengo un método objetivo-c con un par de argumentos de esta manera:

-(NSInteger*) sumOf: (NSInteger*) one and:(NSInteger*) two {... 

En Eclipse, si coloca el cursor sobre el método y el tipo: /**<Enter> se obtiene una pre plantilla Javadoc poblado con etiquetas @param y @return.

¿Es posible lograr algo similar en Xcode? Después de escribir /**<Enter>, me gustaría conseguir esto de forma automática:

/** 
* 
* @param one 
* @param two 
* 
* @return 
*/ 
-(NSInteger*) sumOf: (NSInteger*) one and:(NSInteger*) two {... 
+0

Esto ahora es posible en Xcode 5. Consulte la respuesta en esta publicación: http://stackoverflow.com/a/18899696/1130270 – Lukas

Respuesta

0

Si usted tiene la paciencia, echar un vistazo here ya que explica el comportamiento de terminación y anulaciones en XCode. No sé si esto funcionará para el conjunto de comentarios, pero parece un buen comienzo.

- Frank

1

El menú "scripts de usuario" (ese pequeño icono de desplazamiento negro en la barra de menú de Xcode) tiene un submenú HeaderDoc con plantillas para todo tipo de documentación en la sintaxis de marcado de alta definición. Puede establecer un atajo de teclado para los elementos que desea usar yendo a "Enlaces clave" en la ventana "Preferencias" de Xcode.

Dado que los scripts de usuario son esencialmente scripts de shell, puede usar cualquier lenguaje de scripts para escribir el suyo, así que si lo desea podría incluso escribir un pequeño script con expresiones regulares que analiza los nombres de los parámetros fuera de la línea seleccionada los conceptos básicos de tu comentario de HeaderDoc.

2

He estado usando con éxito en VVDocumenter-Xcode Xcode 5 y funciona bien. Genera automáticamente una plantilla específica para un método cuando ingresas "///" encima del método.

Cuestiones relacionadas