重写时保留注释

从基类继承/覆盖方法时，是否有方法（工具或其他）允许不重复相同的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); 
    } 
}

来源

2014-02-13 Serge

看起来，如果sandcastle需要您引用其库以获得此功能。我不确定这是否正确，因为我只是浏览了文档。如果这是一个交易断路器，您可能希望随着成熟时间关注“https：// github.com/pmacn/DocPlagiarizer”。这是一个自定义构建任务，将作为构建过程的一部分为您复制注释。它目前只做'接口 - >实现'而不是'基类 - >子类'，但拉请求或问题报告是值得欢迎的。免责声明：我创建了这个野兽。 –

我认为你正在寻找inheritdoc：

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

这不是一个standard tag（所以智能感知可能不支持它，为exampple），但它是相当常用 - 特别是Sandcastle supports it。

来源

2014-02-13 15:56:20

如果你正在寻找一个工具，你可以尝试GhostDoc扩展视觉工作室。它可以帮助您预生成评论，并可以从基类收集评论。

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

来源

2014-02-13 15:58:28 Guillaume

重写时保留注释

回答

相关问题