在类上调用点运算符时，C# 显示有关方法的文档

Question

有没有办法以编程方式记录类中的方法并让文档显示就像用户调用点运算符（例如，String.[method]）一样，并且可以查看类中的特定方法的作用？请参阅屏幕截图。我想在 C# 中为一个类创建自定义方法，然后记录它。然后当用户使用该类然后启动点运算符 (.) 时，他们将看到该方法和描述该方法的文档

Answer 1

是的。使用XML 文档注释。

在 Visual C# 中，您可以通过将 XML 元素包含在源代码中注释所引用的代码块之前的特殊注释字段（由三重斜线表示）中来为代码创建文档，例如：

/// <summary>  

///  This class performs an important function.  

/// </summary>  

public class MyClass{}  

另请参阅使用 XML 注释记录您的代码

该<summary>标记非常重要，我们建议您包含它，因为它的内容是 IntelliSense 或 API 参考文档中类型或成员信息的主要来源。

Answer 2

您可以为成员使用内联文档 xml 标签。使用摘要来解释方法或其他成员。您可以使用其他标签来获取详细的文档。

MSDN 文档

/// <summary>

/// The main Math class.

/// Contains all methods for performing basic math functions.

/// </summary>

public class Math

{

    // Adds two integers and returns the result

    /// <summary>

    /// Adds two integers and returns the result.

    /// </summary>

    public static int Add(int a, int b)

    {

        // If any parameter is equal to the max value of an integer

        // and the other is greater than zero

        if ((a == int.MaxValue && b > 0) || (b == int.MaxValue && a > 0))

            throw new System.OverflowException();

        return a + b;

    }

}

并且您可以使用一些第三方工具来创建使用此标签的 html 或 chm 文档文件。

一个例子是Sandcastle 文档