如何复制.NET API文档？

Question

如果某个类实现了接口中定义的方法，您可以选择是复制文档还是使用<see cref="..." />引用它。

public interface IPerformer
{
    /// <summary>
    /// Do something useful.
    /// </summary>
    /// <param name="something">Object to do something with</param>
    void Do(Something something);
}

public class Implementation : IPerformer
{
    /// <copy from="IPerformer" /> # that is what I want!
    public void Do(Something something)
    {
        // implementation ...
    }
}

是否可以让API文档工具（Sandcastle）自动复制文档（什么会使阅读API文档更加舒适）？类似于Java Doc的@inheritDoc？

Answer 1

不是您正在寻找的答案，但GhostDoc可以为您做到这一点。它会将界面中的注释拉入实现中。

Answer 2

Jetbrain的Resharper允许您从界面复制注释（或者当您从界面创建实例时，它会自动为您复制它们），但是如果您更新界面的注释，则必须删除注释并再次从基础复制注释！

Answer 3

Sandcastle Help File Builder（SHFB）通过inheritdoc tag提供此功能。

Answer 4

AtomineerUtils Pro Documentation将自动为您复制基类，接口和重载文档。 （它与GhostDoc类似，但它是一个功能更强大且可配置的文档生成器。）