c# - 如何复制 .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 文档更舒服）？类似于@inheritDocJava Doc 的东西？

Answer 1

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

Answer 2

Sandcastle 帮助文件生成器(SHFB) 通过inheritdoc 标签提供此功能。

Answer 3

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

Answer 4

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