重写时保留注释

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可能不支持它，举个例子)，但是它非常常用--特别是沙堡支持它。

Answer 2

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

由于生成的注释是一个常规注释，因此IntelliSense正确地支持它，但是当基本注释被更改时，它不会神奇地更新。