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

Статья
02/20/2013

<see cref="member"/>

Параметры

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

Заметки

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

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

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

// 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()
    {
    }
}

Пример использования тега <see> см. в разделе <summary>.

См. также

Ссылки

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

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

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