objective c - Crear entrada de "Ayuda rápida" en Xcode

objective-c doxygen

Question

¿Cómo creo entradas rápidas de ayuda en Xcode para mi propio código? Solo lo quiero como soporte de codificación, es decir, como la funcionalidad de Eclipse al codificar Java. En Eclipse, obtienes un comentario que ingresaste encima de un método cuando cierras un método en otro lugar.

El equivalente de Xcode parece ser la "Ayuda rápida".

¿Realmente no hay otra manera que usar Doxygen? Doxygen parece exagerado para el pequeño proyecto en el que estoy trabajando. Por el momento, sé con certeza que solo deseo que la ayuda rápida se complete a fondo, así que evite dar pistas como "tiene que crear una documentación para su proyecto".

Realmente agradecería cualquier ayuda, ya que lo único que pude encontrar sobre este tema fue esta question .

Pero como puede ver, no hay solución disponible.

Answer 1

A partir de Xcode 5.0, el formateo de Doxygen y HeaderDoc para variables y métodos se analiza automáticamente y se procesa en el Popover de Ayuda Rápida. Más información al respecto here , pero aquí hay algunas claves:

/**
 * Add a data point to the data source.
 * (Removes the oldest data point if the data source contains kMaxDataPoints objects.)
 *
 * @param aDataPoint An instance of ABCDataPoint.
 * @return The oldest data point, if any.
 */
 - (ABCDataPoint *)addDataToDataSource:(ABCDataPoint *)aDataPoint;

se presenta en Xcode como:

En cuanto a las propiedades, es tan fácil como:

/// Base64-encoded data.
@property (nonatomic, strong) NSData *data;

Cuando se hace clic en la opción, aparece este adorable popover:

Answer 2

Creo que la única manera es crear un conjunto de documentación para su código y luego instalarlo en XCode:

La ayuda contextual de Xcode 4, que Apple llama "Ayuda rápida", depende completamente de los conjuntos de documentación instalados. Xcode 4 descarga automáticamente los conjuntos de documentación (incluidas las actualizaciones) para Mac OS y las API de iOS, pero también puede instalar conjuntos de terceros.

(...)

Una vez que haya creado su conjunto de documentación, puede instalarlo en las preferencias de Xcode (en la pestaña Documentación). Suponiendo que el conjunto de documentos está correctamente construido e instalado, la Ayuda rápida debería "funcionar". Por supuesto, esto tiene un uso limitado a menos que comparta una API compleja con un grupo o con el mundo en general.

fuente: http://xcodebook.com/2011/04/providing-your-own-quick-help/

Guía del conjunto de documentación de Apple: http://developer.apple.com/library/mac/documentation/DeveloperTools/Conceptual/Documentation_Sets/

Answer 3

Para cualquier persona interesada en cómo hacer esto en Swift 3.

/**
 Makes a route

 - Parameters:
      - Parameter1 : The *x* component.
      - Parameter2 : The *y* component.
 - Throws: Error.IncorrectX if the x parameter 
    is less than zero.

 - Returns: A new integer answer which is x*y.

*/

Los parámetros 1 y 2 tienen que ser los nombres correctos que haya dado a sus parámetros.

Answer 4

Puede crear un DocSet con AppleDoc fácilmente y genera QuickHelp-Links (opción ⌥ + clic del mouse).

Los ejemplos y el Binario para el Comando de la Terminal están aquí:

http://gentlebytes.com/appledoc-docs-examples-basic/

Lo intenté y solo usé los conmutadores básicos y el nuevo DocSet funciona con QuickHelp:

./appledoc --project-name testdocs --project-company "My Company" --company-id com.mycompany --output ~/Desktop ~/Desktop/appledoc-master

Answer 5

Sí ... puede ... Aquí hay un "Fragmento" listo para usar que puede arrastrar o autocompletar, etc.

/** 
 * <#summary#>
 * @param <#name#> <#how you gonna get it?#>
 * @param <#name#> <#really, there''s more?#>
 * @return <#name#> <#what do you want!#>
 */

Arrastra ese "sobre" el fragmento de "cosa" y dale me gusta, ya sabes ... configúralo ...

y ya lo tienes ...

Answer 6

Xcode 5 ahora tiene soporte integrado 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 barra lateral de ayuda se verá así:

Aquí hay un práctico fragmento de código. Puedes agregar tu biblioteca de código de Xcode para simplificar la documentación del método:

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

Ahora, puedes escribir "doxy" y poof! Usted tiene su plantilla doxygen.