c# - 自动生成文档和继承

Question

我有基本的 API Controller :

 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 的 child :

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

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

我想获得这两种方法的描述。
如何在不覆盖的情况下获取子类中 GET 方法的 XML 注释？
或者我应该将它复制到我的子类(class)吗？

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

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

另一个问题:如何将 ghostdoc 与默认帮助页面一起使用？

Answer 1

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