Comentarios de Xcode autocompletado (estilo appledoc)

Question

Encuentro particularmente doloroso documentar mis interfaces porque necesito escribir todo yo mismo. Así que pensé que no debía ser el único como este y comencé a buscar una manera de reducir mi dolor pero no encontré demasiado.

Mi pregunta es, ¿hay un atajo o una forma de tener Xcode autocompletar mis comentarios? Por ejemplo, me gustaría mucho si escribo /** + [tab] que completa automáticamente a:

/** 
* [cursor here] 
* 
* (maybe some pre-populate a list of arguments for the method below) 
*/ 
- (void)test:(NSString *)testString another:(NSString *)another; 

Gracias!

Answer 1

Utilice la función de fragmentos de Xcode. Puede crear un fragmento con el texto que desee y agregar elementos en el texto que debe rellenar. Para crear un fragmento, simplemente seleccione un texto en un editor de Xcode y arrástrelo a la biblioteca de fragmentos. Puede configurar el acceso directo de finalización, así que algo como m-comment podría ser su comentario método estándar:

Escribiendo el primer bit de m-comment a continuación, muestra todo el acceso directo (y cualquier otro terminaciones), y la aceptación de la finalización agrega un comentario con las partes parametrizadas a la espera de ser llenado de la manera habitual, se puede ficha de una a la siguiente:.

se indica que una parte determinada del texto es un campo para ser llenado i n al encerrarlo en <# y #>, como: <#method name#>.

Por supuesto, uno de los puntos fuertes de Objective-C es que el nombre del método generalmente le dice cuáles son los parámetros. Repetir eso en un comentario parece un trabajo extra innecesario. Xcode 3 tenía un mejor soporte para scripts que incluían scripts que generarían automáticamente comentarios de HeaderDoc con parámetros. Sin embargo, no fueron ampliamente utilizados, probablemente porque ese tipo de comentarios no fueron realmente útiles.