c# - 对派生类中的重写方法使用基类 Doxygen 注释

Question

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

一个例子：

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();

在上面的示例中，将鼠标悬停在 (say)d1.CoolFunction上。可以显示基类注释“关于这个很酷的功能”吗？当前显示基本原型信息，但没有其他信息。

这个关于 PHP 的相关问题似乎给出了答案，但是：

• 1. 我无法让它在 C# 中工作（也许语法略有不同？）
• 2. 这仍然需要为所有派生类中的每个方法编写一个Doxygen注释块，如果可能的话我想避免

标签： c#doxygen

Answer 1

你可以试试

/// <inheritdoc />

我不确定它是否适用于 doxygen，但它是用于 XML 文档的方法。 看这里

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...
    }
}