У меня есть контроллер базовых 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";
}
}
я использую страницу справки для создания автоматической документации. И в результате я получаю:
Я хочу, чтобы получить описание двух методов.
Как я могу получить комментарии XML к методу GET в дочернем классе без переопределения?
Или мне нужно скопировать его в класс моего ребенка?
Когда я использую <inheritdoc />
в HouseController я получаю тот же результат, как и выше, и я не хочу, чтобы переопределить каждый метод, когда он не нужен:
/// <inheritdoc />
public override IQueryable<House> GetByYear(int year)
{
return base.GetByYear(year);
}
Другой вопрос: Как я могу использовать GhostDoc с невыполнением Страница справки?
Вы спрашиваете, следует ли документировать производные классы и переопределять? Хм ... да. Вам не нужно документировать унаследованные члены, которые не являются скрытыми. –
Есть ли способ скопировать комментарии xml к производным классам? –
Может ли кто-нибудь мне помочь? –