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

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

Ответ 1

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

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

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

Ответ 2

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

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

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

Ответ 3

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

Ответ 4

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

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

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

Ответ 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);
    }

Ответ 6

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

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

}