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";
    }
}

ヘルプページを使用して自動ドキュメントを作成しています。その結果、次のようになります。

ここに画像の説明を入力

2つの方法の説明を取得したいと思います。
オーバーライドせずに、子クラスのメソッド GET への XML コメントを取得するにはどうすればよいですか?
または、子クラスにコピーする必要がありますか？

HouseControllerで使用する<inheritdoc />と、上記と同じ結果が得られます。必要でない場合は各メソッドをオーバーライドしたくありません。 

     /// <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 に答える