¿Cómo crear documentación para variables de instancia y métodos en Xcode?

Question

Me gustaría poder Alt-Click una variable de instancia (o un método) como parte del programa que creé y leer cuál es su propósito.

El hecho de que Xcode me esté diciendo que la variable de clase está declarada en - es bueno pero no suficiente. En este caso, me gustaría ver el texto personalizado que escribí para describir qué es realmente un asset. Además, el tipo de ivar también sería útil para saber.

¿Cómo se puede hacer esto? En este caso, me pregunto qué es exactamente lo que quiero decir con assets

Me pregunto específicamente si esta información puede ser vista desde el interior Xcode, similar a cómo Eclipse muestra JavaDoc contenido.

Answer 1

Usted tendría que crear un conjunto de documentación para su proyecto e instalarlo en Xcode. appledoc puede ayudarlo con esto. Esta es una herramienta de línea de comandos que puede generar documentación en el estilo de Apple a partir de comentarios formateados especialmente en sus encabezados. También puede integrar esto en su proceso de compilación con una fase de compilación de script de ejecución, de modo que la documentación esté siempre actualizada.

Para proyectos pequeños, por lo general no vale la pena el esfuerzo y probablemente sea mejor simplemente agregar comentarios a los archivos de encabezado y saltar allí con Cmd-clic (Ctrl + Cmd + flecha izquierda para volver a donde vino de).

Answer 2

Es probable que desee echar un vistazo a la documentación de Apple en Documentation Sets, así como su artículo en generating doc sets using Doxygen. Este último está basado en Xcode 3.x, por lo que su relevancia es algo cuestionable, pero sería una buena idea echar un vistazo, no obstante.

Dicho esto, si decide usar Doxygen (alternativas como HeaderDoc se pueden usar para la documentación, pero no estoy seguro de qué hay disponible para crear conjuntos de documentos), parece que el punto principal es usted Querrá lanzar GENERATE_DOCSET=YES en su Doxyfile (o lo que sea que decida llamarlo). Después de eso, simplemente arrojaría los resultados al ~/Library/Developer/Shared/Documentation/DocSets (según la documentación de Doxygen). No sé si esto funciona en Xcode 4.x; sin embargo, vale la pena intentarlo, y sería bueno volver a escucharlo.

Nota: la mayor parte de esto se basó en this answer por Barry Wark. El crédito de la figura debe pagarse allí, ya que no me hubiera molestado en investigar si no fuera por su respuesta.