如何创建///摘要

如何在Visual Studio中生成此类摘要？

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

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

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

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

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

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

我可以推荐GhostDoc使它变得更加容易。

键入3次/，Visual Studio将填充其余的代码。

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

除了为您提供的样板注释模板之外，我建议您看一下您可能使用的其他标签：http : //msdn.microsoft.com/zh-cn/library/5ast78ax.aspx

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

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

在您的property / method / etc之前的行中，只需键入///，然后Visual Studio将自动添加XML标记。

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

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

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

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