C#：如何为自定义类方法添加文档，实现点运算符调用时显示？

当然可以啦！在C#里，你完全可以给自定义类的方法添加文档注释，让用户在使用点运算符（.）触发智能感知时，看到和系统内置类（比如String）一样的方法描述，和你截图里的效果完全一致。下面给你一步步讲怎么实现：

1. 使用XML文档注释（最常用方式） #

直接在方法、类的上方写以///开头的注释，Visual Studio会自动识别并把这些内容展示在智能感知里。举个实际例子：

public class MyCustomClass
{
    /// <summary>
    /// 计算两个整数的和
    /// </summary>
    /// <param name="a">参与计算的第一个整数</param>
    /// <param name="b">参与计算的第二个整数</param>
    /// <returns>两个整数相加的结果</returns>
    public int Add(int a, int b)
    {
        return a + b;
    }
}

当用户在代码里输入MyCustomClass.或者调用Add方法时，就能看到你写的这些注释内容，和系统内置方法的提示样式完全相同。

你还可以用更多XML标签让文档更丰富：

• <remarks>：添加方法的额外说明、设计思路或注意事项
• <example>：插入方法的使用示例代码
• <exception>：说明方法可能抛出的异常类型及触发场景

2. 开启项目的XML文档生成功能 #

如果注释写了但智能感知没显示，大概率是没开启XML文档文件的生成：

• 右键你的项目 → 选择「属性」
• 切换到「生成」标签页
• 在「输出」区域勾选「XML文档文件」，路径可以保留默认，也能自行指定

编译项目时会生成对应的XML文件，VS就能读取这些注释内容并展示在智能感知里了。

3. 扩展方法的文档注释 #

要是你给现有类（比如String）写扩展方法，同样可以用XML注释，写法和普通方法一致：

public static class StringExtensions
{
    /// <summary>
    /// 将字符串转为大写并添加感叹号后缀
    /// </summary>
    /// <param name="str">需要处理的原始字符串</param>
    /// <returns>处理后的结果字符串</returns>
    public static string ToUpperWithExclamation(this string str)
    {
        return str.ToUpper() + "!";
    }
}

当用户输入"hello".时，就能看到这个扩展方法的注释提示了。

内容的提问来源于stack exchange，提问作者user5199