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

Статья
06/10/2015

<see cref="member"/>

Параметры

cref = " member"
Ссылка на член или поле, которое может вызываться из текущей среды компиляции. Компилятор проверяет, существует ли данный элемент кода и передает ли он member имени элемента в выходных XML-данных.Поместите член в двойные кавычки (" ").

Заметки

<Тег увидеть> позволяет указать ссылку из текста. Используйте <seealso>, чтобы указать, что текст должен быть помещен в разделе " см. также ". Используйте атрибут cref, чтобы создать гиперссылки на страницы документации для элементов кода.

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

В следующем примере показан общий тег> <" см. в разделе.

// compile with: /doc:DocFileName.xml  

/// text for class TestClass 
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class. 
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary> 
    public static void DoWork(int Int1)
    {
    }

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

См. также

Ссылки

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

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

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