2

我有基本的 API 控制器：

 public class BaseController<T> : ApiController
{
    /// <summary>
    /// Method GetByYear in Base class
    /// </summary>
    /// <param name="year"></param>
    /// <returns></returns>
    public virtual IQueryable<T> GetByYear(int year)
    {
        return null;
    }
}

和刚刚从基础继承方法 GetByYear 的孩子：

public class HouseController : BaseController<House>
{
    /// <summary>
    /// Method Test
    /// </summary>
    /// <returns></returns>
    public string Test()
    {
        return "Test";
    }
}

我使用帮助页面来创建自动文档。结果我得到：

在此处输入图像描述

我想了解这两种方法的描述。
如何在不覆盖的情况下获取子类中方法 GET 的 XML 注释？
或者我应该把它复制到我的孩子班吗？

当我<inheritdoc />在 HouseController 中使用时，我得到与上面相同的结果，并且我不想在不需要时覆盖每个方法： 

     /// <inheritdoc />
    public override IQueryable<House> GetByYear(int year)
    {
        return base.GetByYear(year);
    }

另一个问题：如何在默认帮助页面中使用 ghostdoc？

4

2 回答 2

1

您可以使用/// <inheritdoc />.

于 2015-09-01T22:37:49.450 回答
0

它可能取决于将 XML 注释转换为实际文档的程序，但例如，MSDN 只是复制基本文档，并指出它是从基类继承的。所以你不需要复制派生成员的文档（除非它们被覆盖并且行为不同，因此需要不同的文档）

于 2015-09-01T22:42:44.867 回答