如何在 Visual Studio 2008/2010 中注释方法

Question

我必须如何在 Visual Studio 中注释方法，以便在我想选择方法时可以在工具提示中看到我的描述？

Answer 1

You use XML Documentation with 3 slashes (///)

   /// <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 you can find a tutorial on this type of documentation with a lot of examples.

Answer 2

If you type three slashes in the line above your method ( /// ) it will expand to a template for XML documentation. Anything you fill in the summary section will show up in the tooltip.

The template should look something like this (very simple example):

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

Answer 3

In the line immediately Above the method enter three forward slashes /// and the template will appear auto-magically. Enter some text and it will be displayed.

Answer 4

To make the documentation a little bit easier you should take a look at GhostDoc .

Also if you built an assembly and like to use this somewhere else you should check in your Project Properties under Build the checkbox XML documentation file and always take care that this file will have the same name as your assembly and will stay in the same folder. Than these comments will also be used for IntelliSense when you added only a reference to the resulting assembly file.

Maybe this link also provides some useful informations for you.

Answer 5

For me, in the following manner too (in VS 2008):

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

}

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);
    }