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)

这不是standard tag（因此Intellisense可能不支持它，例如），但它非常常用 - 特别是Sandcastle supports it。

Answer 2

如果您正在寻找工具，可以尝试使用GhostDoc扩展名为visual studio。它可以帮助您预先生成注释，并可以从基类中获取注释。

由于生成的评论是常规评论，因此IntelliSense会对其进行正确支持，但在更改基础评论时不会神奇地更新。

覆盖时保留注释

2 个答案: