<value> (руководство по программированию на C#)

Статья
11/05/2008

Обновлен: Ноябрь 2007

<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 _name data member.</value>
    public string Name
    {
        get
        {
            return _name;
        }
        set
        {
            _name = value;
        }
    }
}

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

См. также

Основные понятия

Руководство по программированию в C#

Поделиться через