iphone - plus - Objetivo del método C Comentarios

iphone 6 precio

Question

¿Cuál es la forma correcta de comentar los métodos para el Objetivo C? Por ejemplo, en .Net agregaría un comentario xml como:

/// <summary>
/// Summary of method
/// </summary>
/// <param name="FileName">The document''s original filename.</param>  
/// <returns>Decoded filename</returns>  

¿Hay un equivalente para el Objetivo C?

Answer 1

Como hago es así,

//-----------------------------------------------------------------------------------------------------//
#pragma mark - Table view Datasource -
//-----------------------------------------------------------------------------------------------------//

Answer 2

El estilo de comentario que mencionas parece ser del tipo que un generador de documentación recoge para generar documentación para ti.

El estilo equivalente de comentar sobre el objetivo-c dependería, por lo tanto, del generador de documentación que elija. No hay por defecto uno que yo sepa.

Puedes usar algo como Doxygen o appledoc si quieres algo que dé resultados similares a los de la propia documentación de desarrollador de Apple. Esta página detalla el formato de comentarios. Ejemplo: GBComment.h

Answer 3

Hay documentos de encabezado appledoc que se pueden usar, los mismos que usa Apple.

Para métodos individuales, la mejor guía es usar nombres muy descriptivos, esto es bastante fácil en Objective-C con los parámetros entremezclados en el nombre del método. Esto generalmente evita la necesidad de comentarios de parámetros individuales.

Como en cualquier lenguaje, los nombres de los métodos descriptivos y los métodos cortos de un solo propósito superan ampliamente los comentarios que envejecen mal a medida que cambia el código.

Answer 4

No te olvides de las marcas de pragma para bloquear tu código. Ayuda a XCode a segregar los métodos en el menú desplegable. También rompe visualmente su archivo fuente y hace que sea más fácil de leer.

Así es como bloqueo secciones de código:

///////////////////////////////////////////////////////////////////////////
#pragma mark -
#pragma mark View Lifecycle
#pragma mark -
///////////////////////////////////////////////////////////////////////////

- (void) functionsHere

Termina haciendo esto en XCode:

Answer 5

Usted usaría

//for a single line comment
/*Use this for the start of a block comment
*/Use this for the end of a comment
   /*text text text;
   code code;
   code code code;//comment
   code;//comment
   code;*/

Answer 6

/**
*   @brief  set refresh datetime
*
*   @param  value of refresh datetime
*
*   @return
*
*/

Esto se muestra en la ayuda rápida

piensa