如何创建///摘要

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 属性的位置，您可以在异常元素内容中填写情况。

如果在文档生成后向方法添加任何参数，那么当您将其添加到文档时，智能感知也会非常有助于填写新参数名称。这是一个非常巧妙的功能。

Answer 3

输入三次 /，Visual Studio 将填充其余代码。

Answer 4

将光标放在要记录的方法或类之前的行上，然后键入

///

。 Visual Studio 将生成 XML 文档标签，例如 

<summary>

 和 

<param>

，然后您可以填写详细信息。

Answer 5

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

除了它为您提供的样板注释模板之外，我建议您查看一下您可能使用的其他标签：

推荐用于 C# 文档注释的 XML 标签

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

Answer 6

使用

GhostDoc等工具。它将通过右键单击方法名称来生成。

Answer 7

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

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

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

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

Answer 8

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

Answer 9

我可以推荐

GhostDoc 让这变得更加容易。