自動生成文檔和繼承

Question

我有基本的 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;
    }
}

和剛剛從 base 繼承方法 GetByYear 的孩子：

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

我使用幫助頁面來創建自動文檔。 結果我得到：

我想得到這兩種方法的描述。
如何在不覆蓋的情況下獲取子類中方法 GET 的 XML 注釋？
還是我應該將其復制到我的孩子班級？

當我在 HouseController 中使用<inheritdoc /> ，我得到與上面相同的結果，並且我不想在不需要時覆蓋每個方法：

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

另一個問題：如何在默認幫助頁面中使用 ghostdoc？

Answer 1

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

Answer 2

它可能取決於將 XML 注釋轉換為實際文檔的程序，但例如，MSDN 只是復制基本文檔，注意它是從基類繼承的。 所以你不需要在派生成員上復制文檔（除非它們被覆蓋並且行為不同，因此需要不同的文檔）