<inheritdoc>啥意思

使用场景

你定义了一个接口并写好了一些代码注释在接口上的方法上;
但每个实现此接口的类是否还需要再写一遍这些注释呢,假如不写似乎无法查看到方法的功能说明呢,
这时你就可以在实现方法上加入///标记,这样文档注释就继承下来了

示例

  • 定义了一个接口,并给接口方法写了方法注释
namespace InheritDoc
{
    /// <summary>
    /// 打招呼接口
    /// </summary>
    internal interface ICanSayHello
    {
        /// <summary>
        /// 跟朋友打招呼吧
        /// </summary>
        void SayHello();
    }
}

  • 一个实现类,实现方法上只加了///标记
namespace InheritDoc
{
    /// <inheritdoc />
    internal class ChineseCanSayHello:ICanSayHello
    {
        /// <inheritdoc />
        public void SayHello()
        {
            Console.WriteLine("你好啊朋友,吃了吗");
        }
    }
}

  • vs鼠标悬停还是可以看到接口方法的注释的

参考

https://docs.microsoft.com/zh-cn/dotnet/csharp/language-reference/xmldoc/recommended-tags

posted @ 2022-07-20 09:34  喜爱糖葫芦  阅读(668)  评论(0编辑  收藏  举报