Как прокомментировать метод в Visual Studio 2008/2010

Question

Привет, я хочу знать, как я должен прокомментировать метод в VS, чтобы я видел свое описание во всплывающей подсказке, когда я хочу выбрать этот метод?

Answer 1

Вы используете документацию XML с 3 слешами (///)

   /// <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)
   {
   }

Здесь вы можете найти учебное пособие по этому типу документации с большим количеством примеров.

Answer 2

Если вы введете три косые черты в строке над вашим методом (///), он развернется в шаблон для документации XML. Все, что вы заполните в разделе summary, появится во всплывающей подсказке.

Шаблон должен выглядеть примерно так (очень простой пример):

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

Answer 3

В строке сразу над методом введите три косые черты ///, и шаблон появится автоматически. Введите текст, и он будет отображен.

Answer 4

Чтобы сделать документацию немного проще, взгляните на GhostDoc .

Также, если вы собрали сборку и хотите использовать ее где-то еще, вы должны проверить в свойствах своего проекта в разделе Построить флажок XML documentation file и всегда следить за тем, чтобы этот файл имел то же имя, что и ваша сборка, и оставался в та же папка. Затем эти комментарии также будут использованы для IntelliSense, когда вы добавили только ссылку на полученный файл сборки.

Может быть, эта ссылка также предоставляет некоторую полезную информацию для вас.

Answer 5

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

Answer 6

Для меня тоже следующим образом (в VS 2008):

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

}