AVISO: Cualquier pregunta que no cumpla ninguno de estos criterios podrá ser borrada sin previo aviso.

1
1

Soy un poco maniático con esto y por cada método que defino documento a lo javadoc. Los que yo creo evidentemente no se pueden automatizar pero los de la API me gustaría que estuviesen documentados automáticamente. Por ejemplo que si yo añado

- (id)initWithFrame:(CGRect)frame {
}

Pueda ejecutar un pequeño script para que automáticamente se consulete la documentación para ese método y se extraigan la definición (marcada como 'abstract' en el bubble al pulsar alt+click sobre un símbolo), los parámetros y el return, de existir, de forma que seleccionando o con el cursor sobre un método, y ejecutando el script obtuviese

/**
 * Initializes and returns a newly allocated view object with the specified frame rectangle.
 *
 * @param aRect: The frame rectangle for the view, measured in points.
 * @return An initialized view object or nil if the object couldn't be created.
 */
- (id)initWithFrame:(CGRect)frame {
}

Preguntas, ¿existe un script parecido? ¿Doxygen hace algo por el estilo o solo extrae texttos de nuestro código para crear la documentación? Y la más importante ¿existe posibilidad de hacer algo así? Es decir, que mediante un script de Xcode pueda acceder a la documentación. Si es así me plantearé hacerlo.

preguntado 08 Mar '12, 14:39

emenegro's gravatar image

emenegro
3.7k163264

cerró 02 Abr '12, 09:51

La pregunta ha sido cerrado por el siguiente motivo "Problema no reproducible" por La pregunta ha sido cerrado por la siguiente razón "Problema no reproducible" by emenegro 02 Abr '12, 09:51


Buenas emenegro,

El tema de la documentación en Objective-C es algo extraño. Se supone que Apple invita a los desarrolladores a declarar métodos con nombres muy explicativos y escribir código que sea legible; sólo habría que documentar procesos concretos que necesiten de alguna reseña en particular.

Si deseas algo tipo doxygen pero más elegante (esto bajo mi punto de vista) usa appledoc. Siguiendo su sintaxis, puedes llegar generar una documentación igual que la que Apple ofrece para sus SDKs.

¡Un saludete!

enlace permanente

respondido 08 Mar '12, 15:38

juanmac's gravatar image

juanmac ♦
3.0k334181

Gracias juanmac pero no es eso lo que busco, no quiero generar documentación a partir del texto sobre cada método sino al revés, texto sobre cada método a partir de la documentación oficial.

Lo de que los métodos son autoexplicativos por la signatura me parece un poco utópico. Mismamente el ejemplo que he cogido, de la doc oficial, es imposible explicarlo solo con la signatura.

(08 Mar '12, 15:41) emenegro