<exclude>【出力除外】
<inheritdoc>【ドキュメント継承】
<preliminary>【暫定】

メモ

<exclude>【出力除外】

  • 出力から除外

<inheritdoc>【ドキュメント継承】

  • ドキュメントを継承して出力
    • 型・インタフェース・仮想メンバ・インタフェースメンバ実装・コンストラクタで指定する場合、cref属性は省略可 (基本クラスから継承)
    • cref属性指定：未継承のコメント挿入可
    • select属性指定：部分的なコメント挿入可

<preliminary>【暫定】

  • 暫定的で変更の可能性あり
    • クラス等に指定すると、メンバ全てが対象

構文

<exclude />


<inheritdoc /> 

<inheritdoc [cref="メンバ名"] [select="XPath"] /> 


XPathの例：
"param"：パラメータのみ継承
"summary|remarks"：概要と備考を継承


<preliminary />

<preliminary>暫定の説明</preliminary>

外部リンク

例

/// <summary>クラスの概要 (ClassBase)</summary>
/// <remarks>クラスの備考 (ClassBase)</remarks>
public class ClassBase
{
    /// <summary>コンストラクタの概要 (ClassBase)</summary>
    /// <remarks>コンストラクタの備考 (ClassBase)</remarks>
    public ClassBase() { }
}

/// <inheritdoc/>
public class ClassInherit : ClassBase
{
    /// <inheritdoc/>
    public ClassInherit() : base() { }

    /// <summary>メソッドＡの概要</summary>
    /// <remarks>メソッドＡの備考</remarks>
    /// <param name="p1">パラメータ１の説明</param>
    /// <seealso cref="ClassBase"/>
    public void MethodA(int p1) { }

    /// <summary>メソッドＢの概要</summary>
    /// <inheritdoc cref="MethodA" select="remarks|param"/>
    /// <param name="p2">パラメータ２の説明</param>
    public void MethodB(int p1, int p2) { }

    /// <exclude/>
    public void MethodExclude() { }

    /// <summary>暫定メソッド</summary>
    /// <preliminary/>
    public void MethodTemp() { }
}