覆盖时保留注释

Question

有没有一种方法(工具或其他东西)允许在从基类继承/重写方法时不重复相同的XML注释？

例如.:

/// <summary>
/// Represent a brand new object in .NET
/// </summary>
public class MyObject : Object
{
    /// <summary>
    /// Copy-Paste the same Xml comment 
    /// like in the base class is boring!
    /// </summary>
    /// <param name="obj">and params too!! ((</param>
    /// <returns>this one too!!! (((</returns>
    public override bool Equals(object obj)
    {
        return base.Equals(obj);
    }
}

Answer 1

我想你正在寻找inheritdoc:

/// <inheritdoc />
public override bool Equals(object obj)

这不是标准标签(因此Intellisense可能不支持它,例如),但它非常常用 - 特别是Sandcastle支持它.