Capítulo 13:

 Documentos de códigos. Etiquetas (4/5)

Parámetros

Cref = "member". Referencia a un miembro o campo al cual se puede llamar desde el entorno de compilación actual. El compilador comprueba si el elemento de código dado existe y convierte member al nombre de elemento canónico en el resultado XML. member debe aparecer entre comillas dobles ("").

Description. Descripción del acceso al miembro.

Ejemplo:

/// <permission cref="System.Security.PermissionSet"> /// Este método es de acceso público.</permission> public static void Acceso() {}

<returns>. La etiqueta <returns> se debe utilizar en el comentario de una declaración de método para describir el valor devuelto.

Sintaxis:

<returns>description</returns>

Parámetros

Description. Descripción del valor devuelto.

Ejemplo:

/// <returns>devuelve la matriz con las filas /// encontradas.</returns> public static string[] GetZero() { return new string[2]; }

<see>. La etiqueta <see> permite especificar un vínculo desde dentro del texto. Se utiliza <seealso> para indicar que el texto debe colocarse en una sección.

Sintaxis:

<see cref="member"/>

Parámetros:

cref = "member". Referencia a un miembro o campo al cual se puede llamar desde el entorno de compilación actual. El compilador comprueba si el elemento de código dado existe y pasa member al nombre de elemento en el resultado XML. Se agrega member entre comillas dobles (" ").

Ejemplo:

En el ejemplo de la etiqueta <para> se encuentra una aplicación de <see>.

<seealso>. La etiqueta <seealso> permite especificar el texto que se desea que aparezca en una sección. Se utiliza <see> para especificar un vínculo desde dentro del texto.

Sintaxis:

<seealso cref="member"/>

Parámetros

cref = "member". Referencia a un miembro o campo al cual se puede llamar desde el entorno de compilación actual. El compilador comprueba si el elemento de código dado existe y pasa member al nombre de elemento en el resultado XML. member debe aparecer entre comillas dobles (" ").

Ejemplo:

/// <summary>Método para mostrar datos /// <seealso cref="TestClass.Metodo"/> /// </summary> public static void Metodo(int Int1) { }

 <typeparam>. La etiqueta <typeparam> se debería utilizar en el comentario de una declaración de tipo o método genérico para describir un parámetro de tipo. Agregue una etiqueta para cada parámetro de tipo del tipo o método genérico. El texto de la etiqueta <typeparam> se mostrará en IntelliSense, el informe Web de comentario de código de Explorador de objetos.

Sintaxis:

<typeparam name="name">description</typeparam>

Cursos similares a Diseño de Aplicaciones Orientadas a Objetos (2/3)

1. Diseño de Aplicaciones Orientadas a Objetos (1/3) En esta oportunidad deseamos enseñarte un nuevo curso de programación en el cual... [05/10/11]				91
2. Actionscript 3. Objetos Objetos AS3 . Entra a nuestro tutorial de Actionscript 3 y aprende el lenguaje de... [04/07/11]				121
3. PHP y MySQL. Aplicaciones Web: programación (primera parte) Programación de aplicaciones Web con PHP y MySQL. Con este curso aprenderás el... [02/12/08]				5.012