<value> (C# プログラミング ガイド)

<value>property-description</value>

パラメーター

• property-description
  プロパティの説明。

解説

<value> タグを使用すると、プロパティが表す値の説明を記述できます。Visual Studio .NET 開発環境のコード ウィザードで追加したプロパティには、<summary> タグが追加されます。そのプロパティが表す値を記述するには、<value> タグを手動で追加する必要があります。

コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。

使用例

// compile with: /doc:DocFileName.xml 

/// text for class Employee
public class Employee
{
    private string _name;

    /// <summary>The Name property represents the employee's name.</summary>
    /// <value>The Name property gets/sets the value of the string field, _name.</value>

    public string Name
    {
        get
        {
            return _name;
        }
        set
        {
            _name = value;
        }
    }
}

/// text for class MainClass
public class MainClass
{
    /// text for Main
    static void Main()
    {
    }
}

参照

関連項目

ドキュメント コメント用の推奨タグ (C# プログラミング ガイド)

概念

C# プログラミング ガイド