如何创建///摘要

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

将光标放在要记录并键入的方法或类之前的行上///。Visual Studio 将生成 XML 文档标签，例如<summary>和<param>，然后您可以填写详细信息。

Answer 4

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

Answer 5

我可以推荐GhostDoc使这更容易.

Answer 6

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

Answer 7

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

除了它为您提供的样板评论模板之外，我建议您查看您可能使用的其他标签：http : //msdn.microsoft.com/en-us/library/5ast78ax.aspx

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

Answer 8

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

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

对于模型：在自动属性前使用 3 个正斜杠，即 /// 将生成如下所示的摘要标签，

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