Método 'documentación'

Question

¿Cuál es la sintaxis objetivo-c para documentar el uso de un método? ¿Esto se hace en el archivo .h o .m?

En C# se usa algo como:

/// <summary> 
/// Executes an HTTP GET command and retrieves the information.  
/// </summary> 
/// <param name="url">The URL to perform the GET operation</param> 
/// <param name="userName">The username to use with the request</param> 
/// <param name="password">The password to use with the request</param> 
/// <returns>The response of the request, or null if we got 404 or nothing.</returns> 
protected string ExecuteGetCommand(string url, string userName, string password) { 
... 
} 

¿Se hace esto con la directiva #pragma?

Gracias,

Craig Buchanan

Answer 1

de Objective-C no tiene una función de la documentación incorporada. Apple incluye una herramienta llamada Headerdoc que puede generar documentos a partir de archivos fuente, pero hay several better options. Creo que el más popular es Doxygen, en cuyo caso la sintaxis es el estilo Java /** Documentation here */. Puede consultar el Wikipedia page para ver ejemplos de cómo se usa (aunque con otros idiomas). Apple tiene instructions for using Doxygen with Xcode en su sitio.

Answer 2

Hay una nueva capacidad en Xcode 5 para documentar sus métodos. En el archivo de cabecera, puede añadir comentarios a su función como tal para hacerlos aparecer en la documentación:

/*! Executes an HTTP GET command and retrieves the information. 
* \param url The URL to perform the GET operation 
* \param userName The username to use with the request 
* \param password The password to use with the request 
* \returns The response of the request, or null if we got 404 or nothing 
*/ 
- (NSString *)executeGetCommandWithURL:(NSURL *)url userName:(NSString *)aUserName andPassword:(NSString *)aPassword; 

Nota el signo de exclamación en la primera línea.

Esta documentación se mostrará en la Ayuda rápida en el panel derecho de Xcode, y la descripción se mostrará en la función de autocompletado cuando escriba.