Question

您好我想知道我必须在VS中注释一个方法，当我想选择这些方法时，我会在工具提示中看到我的描述吗？

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

Here您可以通过大量示例找到有关此类文档的教程。

Answer 2

如果在方法（///）上方的行中键入三个斜杠，它将扩展为XML文档的模板。您填写summary部分的任何内容都会显示在工具提示中。

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

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

Answer 3

在紧接方法上方的行中输入三个正斜杠///，模板将自动显示。输入一些文字，然后显示。

Answer 4

为了使文档更容易一些，您应该查看GhostDoc。

此外，如果您构建了一个程序集并且喜欢在其他地方使用它，那么您应该在构建复选框XML documentation file下检查项目属性，并始终注意此文件将与程序集具有相同的名称并将保留在同一个文件夹中。当您仅添加对生成的汇编文件的引用时，这些注释也将用于IntelliSense。

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

Answer 5

对我来说，也是如此（在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);
    }

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

6 个答案: