c# – 覆盖时保留注释

发布时间：2020-12-15 23:42:19 所属栏目：百科来源：网络整理

导读：有没有一种方法(工具或其他东西)允许在从基类继承/重写方法时不重复相同的 XML注释？例如.： /// summary/// Represent a brand new object in .NET/// /summarypublic class MyObject : Object{ /// summary /// Copy-Paste the same Xml comment /// like

有没有一种方法(工具或其他东西)允许在从基类继承/重写方法时不重复相同的 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);
    }
}

解决方法

我想你正在寻找inheritdoc：

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

这不是standard tag(因此Intellisense可能不支持它,例如),但它非常常用 – 特别是Sandcastle supports it.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!