objective c - ¿Cómo incluir la descripción del método Doxygen en la ventana emergente de autocompletado de Xcode?

objective-c autocomplete

Question

Usando Xcode, quiero tener la descripción de Doxygen de mi método debajo de la opción autocompletar, como alloc :

Al escribir, Xcode muestra el autocompletado con los comentarios de la documentación. Puede ver en la imagen, por ejemplo, cuando se selecciona la alloc de las opciones, dice "Devuelve una nueva instancia de la clase receptora" y también enlaces a la documentación.

He podido documentar mi código fuente con Doxygen, por ejemplo

/** 
 This does nothing
*/
 -(void) doNothing
{
    // This does nothing
}

y obtengo los resultados esperados en el archivo HTML que genera Doxygen, pero no sé cómo hacer que esos resultados aparezcan como sugerencias en Xcode.

Answer 1

¡Buenas noticias para todos! Xcode 5 ahora tiene soporte incorporado para comentarios de estilo DOxygen. Entonces, puedes comentar tus métodos de esta manera:

/*!
 * Provides an NSManagedObjectContext singleton appropriate for use on the main 
 * thread. If the context doesn''t already exist it is created and bound to the 
 * persistent store coordinator for the application, otherwise the existing 
 * singleton contextis returned.
 * /param someParameter You can even add parameters
 * /returns The a shared NSManagedObjectContext for the application.
 */
+ (NSManagedObjectContext *)sharedContext;

La ayuda en línea se verá así:

La ayuda rápida se verá así:

Y la ayuda de la barra lateral se verá así:

Aquí hay un fragmento de código útil que puede agregar a su biblioteca de fragmentos de código Xcode para simplificar la documentación del método:

/**
 <#description#>
 @param <#parameter#>
 @returns <#retval#>
 @exception <#throws#>
 */

Ahora, solo puedes escribir "doxy" y poof! Tienes tu plantilla doxygen.

Answer 2

Lo que he encontrado que es mejor que un fragmento de código para comentarios de estilo Doxygen / Javadoc es usar el complemento VVDocumenter-Xcode ¡ Es genial! Después de la instalación, simplemente escriba "///" encima de cualquier código que desee comentar y tomará los parámetros y regresará, así como agregará marcadores de posición para que complete su bloque de comentarios.

Answer 3

Pude lograr lo que quería usando Appledocs, aunque luché un poco con la instalación y la configuración ...

1. Abra xCode y vaya a xCode> Preferencias> Descargas y descargue las ''Herramientas de línea de comandos'' en caso de que no las tenga.

2. Abre terminal y escribe

   git clone git://github.com/tomaz/appledoc.git

3. Cuando haya terminado, vaya a la carpeta appledoc, escriba

   cd appledoc

   e instale appledoc en su carpeta usr / local / bin con este comando:

   sudo sh install-appledoc.sh 

4. Abra cualquier proyecto xCode y vaya al explorador de paquetes a la izquierda, y haga clic en su archivo de proyecto principal (el que tiene la cantidad de objetivos y la versión sdk que se detalla a continuación)

5. En la pestaña Configuración de compilación, busque a continuación el botón ''+ Agregar objetivo'' y ábralo

6. Elija la plantilla ''Agregado'' (asegúrese de elegir iOS o macosx según su proyecto y asígnele el nombre ''Documentación'')

7. Seleccione Documentación, vaya a la pestaña Fases de compilación y, a continuación, haga clic en ''Agregar fase de compilación'' y seleccione Agregar secuencia de comandos de ejecución.

8. Copie y pegue el siguiente código en el campo Ejecutar script:

   #appledoc Xcode script
   # Start constants
   company="ACME";
   companyID="com.ACME";
   companyURL="http://ACME.com";
   #target="iphoneos";
   target="macosx";
   outputPath="~/help";
   # End constants
   /usr/local/bin/appledoc /
   --project-name "${PROJECT_NAME}" /
   --project-company "${company}" /
   --company-id "${companyID}" /
   --docset-atom-filename "${company}.atom" /
   --docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" /
   --docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" /
   --docset-fallback-url "${companyURL}/${company}" /
   --output "${outputPath}" /
   --publish-docset /
   --docset-platform-family "${target}" /
   --logformat xcode /
   --keep-intermediate-files /
   --no-repeat-first-par /
   --no-warn-invalid-crossref /
   --exit-threshold 2 /
   "${PROJECT_DIR}"

9. En las constantes de inicio, puede reemplazar nombres y otros, también asegúrese de usar el objetivo adecuado (iOS o macosx)

10. Finalmente, vaya a Producto> Esquema> Editar esquema> Crear pestaña y agregue su Destino de ''Documentación'', asegúrese de que todas las casillas estén marcadas. De esta manera, cada vez que construyes tu código, tu documentación se actualizará.

Y eso es todo, usted es bueno para ir y comenzar a documentar su código. Tenga en cuenta que, aunque la documentación se actualiza cada vez que realiza una compilación, las sugerencias de ventanas emergentes no se actualizarán hasta que reinicie Xcode. Para las técnicas de documentación adecuadas, lea este artículo.