Cómo comentar un método en Visual Studio 2008/2010

Question

Hola, quiero saber cómo debo comentar un método en VS que veo mi descripción en la información sobre herramientas cuando quiero seleccionar estos métodos.

Answer 1

Si escribe tres barras oblicuas en la línea sobre su método (///) se ampliará a una plantilla para documentación XML. Todo lo que complete en la sección summary se mostrará en la información sobre herramientas.

La plantilla debe ser algo como esto (ejemplo muy sencillo):

/// <summary> 
/// Always returns 1 
/// </summary> 
private Int32 MyMethod() 
{ 
    return 1; 
} 

Answer 2

En la línea inmediatamente por encima del método de introducir tres barras /// y la plantilla aparecerá auto-mágicamente. Ingrese texto y se mostrará.

Answer 3

Se utiliza la documentación de XML con 3 barras (///)

/// <summary> 
    /// Description for SomeMethod.</summary> 
    /// <param name="s"> Parameter description for s goes here</param> 
    /// <seealso cref="String"> 
    /// You can use the cref attribute on any tag to reference a type or member 
    /// and the compiler will check that the reference exists. </seealso> 
    public void SomeMethod(string s) 
    { 
    } 

Here se puede encontrar un tutorial sobre este tipo de documentación con una gran cantidad de ejemplos.

Answer 4

Para mí, de la siguiente manera también (en VS 2008):

void foo 
(int x) 
/* 
Function description here 
*/ 
{ 

} 

Answer 5

de facilitar la documentación un poco más fácil que usted debe echar un vistazo a GhostDoc.

Además, si construyó un ensamblaje y desea utilizarlo en otro lugar, debe verificar las Propiedades del proyecto en Crear la casilla de verificación XML documentation file y siempre tenga cuidado de que este archivo tenga el mismo nombre que su ensamblaje y permanezca en el mismo carpeta. Además, estos comentarios también se usarán para IntelliSense cuando haya agregado solo una referencia al archivo de ensamblaje resultante.

Tal vez this link también proporciona algunas informaciones útiles para usted.

Answer 6

/// <calculate volume> 
    /// 
    /// </volume> 
    /// <lenght lenght="num1"></toconvert> 
    /// <width width="num2"></convert> 
    /// <hight height="num3"></volume> 
    public static void VolBox(int num1, int num2,int num3) 
    { 
     //looks for imput tofind volume of rectangular box 
     int volume; 
     volume = num1 * num2 * num3; 
     Console.WriteLine("the volume of your rectangle box is {0} .",volume); 
    }