C# 自动生成文档和继承

C# 自动生成文档和继承,c#,asp.net-web-api,documentation,xml-documentation,asp.net-web-api-helppages,C#,Asp.net Web Api,Documentation,Xml Documentation,Asp.net Web Api Helppages,我有基本API控制器: public class BaseController<T> : ApiController { /// <summary> /// Method GetByYear in Base class /// </summary> /// <param name="year"></param> /// <returns></returns> pu

我有基本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;
    }
}
公共类BaseController:ApiController
{
/// 
///基类中的GetByYear方法
/// 
/// 
/// 
公共虚拟IQueryable GetByYear(整数年)
{
返回null;
}
}
以及刚从基继承方法GetByYear的子级:

public class HouseController : BaseController<House>
{
    /// <summary>
    /// Method Test
    /// </summary>
    /// <returns></returns>
    public string Test()
    {
        return "Test";
    }
}
公共类房屋控制器:BaseController
{
/// 
///方法试验
/// 
/// 
公共字符串测试()
{
返回“测试”;
}
}
我使用帮助页面创建自动文档。结果我得到:

我想得到这两种方法的描述
如何在不重写的情况下获取子类中get方法的XML注释?
或者我应该把它复制到我的孩子班上

当我在HouseController中使用
时,我得到了与上述相同的结果,并且我不希望在不需要时覆盖每个方法:

     /// <inheritdoc />
    public override IQueryable<House> GetByYear(int year)
    {
        return base.GetByYear(year);
    }
//
公共覆盖IQueryable GetByYear(整数年)
{
返回基数。GetByYear(年);
}

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

您可以使用
//
这可能取决于将XML注释转换为实际文档的程序,但例如,MSDN只是复制基本文档,注意它是从基类继承的。因此,您不需要在派生成员上复制文档(除非它们被重写并且行为不同,因此需要不同的文档)

您是在问是否应该为派生类和重写编写文档?嗯。。。对您不需要记录未重写的继承成员。是否有任何方法可以将xml注释复制到派生类?是的,但为了使用它,我还必须重写基方法。如果没有必要的话,我想让孩子的身体空着overriding@D.Joe不过,我不想麻烦-您的文档生成器应该为您提供一个指向基类的链接。只记录重写的新方法实际上会使文档更有用。我需要一个解决方案作为答案。但是它对我不起作用((.你能帮助我吗?谢谢。这是一个非常好的消息,但为什么它对我不起作用?你必须更具体一些-到底什么不起作用?你用什么来生成实际的文档?(请补充你的问题,而不是作为评论)你能帮助我吗?