在派生 classes 中对重写方法使用基础 class Doxygen 注释

Question

使用 Visual Studio 2019 和 C#（Doxygen 的新版本）。是否可以在 Intellisense 中“应用”来自基本 class 方法的 Doxygen 注释以用于派生的 classes（实际上不必编写 Doxygen 注释块派生的方法 class 本身)?

一个例子：

public abstract class MyBaseClass
{
    /// <summary>
    /// Something about this cool function
    /// </summary>
    protected abstract void CoolFunction();
}

public class MyDerivedClass1 : MyBaseClass
{
    protected override void CoolFunction()
    {
        // Do something specific to derived class 1...
    }
}

public class MyDerivedClass2 : MyBaseClass
{
    protected override void CoolFunction()
    {
        // Do something specific to derived class 2...
    }
}

//...
MyDerivedClass1 d1;
MyDerivedClass2 d2;
d1.CoolFunction();
d2.CoolFunction();

在上面的示例中，将鼠标悬停在（比方说）d1.CoolFunction 上。可以显示基本 class 评论“关于这个很酷的功能”吗？目前只显示基本的原型信息，除此之外什么都没有。

这个related question on PHP似乎给出了答案但是：

1. 我无法在 C# 中使用它（也许语法略有不同？）
1. 这仍然需要为所有派生的 class 中的每个方法编写一个 Doxygen 注释块，我希望尽可能避免这种情况

Answer 1

你可以试试

/// <inheritdoc />

我不确定它是否适用于 doxygen，但这是 XML-文档的方式。 See here

public abstract class MyBaseClass
{
    /// <summary>
    /// Something about this cool function
    /// </summary>
    protected abstract void CoolFunction();
}

public class MyDerivedClass1 : MyBaseClass
{
    /// <inheritdoc />
    protected override void CoolFunction()
    {
        // Do something specific to derived class 1...
    }
}

public class MyDerivedClass2 : MyBaseClass
{
    /// <inheritdoc />
    protected override void CoolFunction()
    {
        // Do something specific to derived class 2...
    }
}

在派生 classes 中对重写方法使用基础 class Doxygen 注释

Use base class Doxygen comment for overridden methods in derived classes

c#

doxygen