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

是否有一种方法可以通过编程方式记录类中的方法，并使文档显示方式与用户调用点运算符（例如，String.[method]）一样，并且可以查看类中的特定方法的功能？参见屏幕截图。我想为C#中的类创建自定义方法，然后将其记录下来。然后，当用户使用该类并启动点运算符（.）时，将向他们展示该方法以及描述该方法的文档

是的。使用

在Visual C中，您可以通过以下方式为代码创建文档： 特殊注释字段中的XML元素（用三个斜杠表示） 在源代码中，直接在 评论指的是，例如：

//
///这个类执行一个重要的函数。
///   
公共类MyClass{}

也看到

标记非常重要，我们建议您包括 因为它的内容是类型或成员的主要来源，所以无法使用 IntelliSense中的信息或API参考文档

---

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

//
///主要的数学课。
///包含用于执行基本数学函数的所有方法。
/// 
公共课数学
{
//将两个整数相加并返回结果
/// 
///将两个整数相加并返回结果。
/// 
公共静态整数添加（整数a、整数b）
{
//如果任何参数等于整数的最大值
//另一个大于零
如果（（a==int.MaxValue&&b>0）| |（b==int.MaxValue&&a>0））
抛出新系统。OverflowException（）；
返回a+b；
}
}

您可以使用一些第三方工具，使用此标记创建html或chm文档文件

---

一个例子是

在方法之前使用

//

/// <summary>  
///  This class performs an important function.  
/// </summary>  
public class MyClass{}  

/// <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;
    }
}