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

Question

我在Visual Studio中应该如何注释一个方法，以便在选择该方法时能够在工具提示中看到我的描述？

- murtek

Answer 1

您使用带有3个斜杠（///）的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)
   {
   }

这里你可以找到一个教程，其中包含许多示例，用于介绍这种类型的文档注释。

- Liviu Mandras

---

你还要确保打开了构建选项，以使编译的DLL工作：打开项目属性，选择“构建”选项，并勾选“XML文档文件”。 - Dan Puzey

为了帮助创建这些注释，请查看 GhostDoc。 - Hans Kesting

通过使用这些XML注释，您还可以使用像SandCastle Help File Builder这样的工具自动生成API文档。 - Ian

Answer 2

如果您在方法上面的一行中输入三个斜杠 (///)，它将展开为一个 XML 文档注释的模板。您在 summary 部分填写的任何内容都将显示在工具提示中。

模板应该看起来像这样（非常简单的示例）：

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

- Colin Pickard

Answer 3

在该方法的上一行输入三个斜杠 ///，模板将会自动出现。输入一些文本，它就会被显示出来。

- 0xDEADBEEF

Answer 4

为了让文档编写更容易，您应该查看GhostDoc。

此外，如果您构建了一个程序集并想在其他地方使用它，您应该在项目属性下的“生成”中勾选“XML文档文件”复选框，并始终确保此文件与您的程序集具有相同的名称并位于相同的文件夹中。然后，当您仅添加对生成的程序集文件的引用时，这些注释也将用于智能感知。

也许this link还为您提供了一些有用的信息。

- Oliver

Answer 5

对我来说，在以下方式中也是如此（在VS 2008中）：

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

}

- Andrei Călin

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

- Cenk Kavsut

---

如何进行注释：如果您写三个斜杠（///）就可以了。 - Cenk Kavsut

然后您可以在音量区下面编写音量计算注释。 - Cenk Kavsut

所有这些名称，如/卷或长度，都基于您编写的变量，在其下面编写注释。 - Cenk Kavsut