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

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

<returns>description</returns>

Параметры

• description
  Описание возвращаемого значения.

Заметки

Тег <returns> следует использовать в комментариях объявления метода для описания возвращаемого значения.

Чтобы обработать комментарии к документации в файле, при компиляции необходимо использовать параметр /doc.

Пример

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <returns>Returns zero.</returns>
    public static int GetZero()
    {
        return 0;
    }

    /// text for Main
    static void Main()
    {
    }
}

См. также

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

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

Ссылки

Рекомендуемые теги для комментариев документации (Руководство по программированию в C#)