如何创建///摘要

Question

如何在Visual Studio中生成这些摘要？

/// <summary>
///  Returns a number
/// </summary>
/// <param name="num"></param>
/// <returns></returns>

Answer 1

在方法，属性等之前键入///。VS将自动生成注释块。

Answer 2

正如其他人所说，默认情况下，当您在成员声明上方的行中键入三个斜杠时，Visual Studio将自动添加文档模板。如果成员应用了任何属性，则在属性上方的行上键入斜杠。

但是，请注意，为方法（或构造函数，属性等）记录的最有用的东西之一是该方法可能生成的异常。可以通过在其余文档之后键入///<exception来添加这些内容。当您接受Intellisense建议时，将为您提供Exception类型的位置作为XML属性，并且您可以在异常元素内容中填写环境。

如果在生成文档后将任何参数添加到方法中，那么当您将其添加到文档中时，Intellisense对于填写新的参数名称也非常有用。这是一个非常漂亮的功能。

Answer 3

使用GhostDoc之类的工具。它将使用右键单击方法名称生成。

Answer 4

我可以推荐GhostDoc让这更容易。

Answer 5

键入三次/并且Visual Studio将填充其余代码。

Answer 6

将光标放在要记录的方法或类之前的行上，然后键入“///”。 Visual Studio将生成XML文档标记，您可以填写详细信息。

Answer 7

就像乔治所说的那样，///在上面的行上会自动生成它。

除了它给出的样板评论模板之外，我建议你看看你可以使用的其他标签：http://msdn.microsoft.com/en-us/library/5ast78ax.aspx

这可以与Sandcastle等其他工具结合使用，自动构建CHM指南等。

Answer 8

在属性/方法/ etc之前的行上，只需键入///，然后Visual Studio将自动添加XML标记。

Answer 9

对于控制器：在方法之前使用3个正斜杠，即///，它将生成类似这样的摘要标记，

     /// <summary>
     /// 
     /// </summary>
     /// <param name="searchKey"></param>
     /// <returns></returns>

对于模型：在自动属性之前使用3个正斜杠，即///将生成类似这样的摘要标记，

     /// <summary>
     /// 
     /// </summary>