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

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

  • Статья

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

<paramref name="name"/>

Параметры

  • name
    Имя параметра, на который нужна ссылка. Заключите имя в двойные кавычки (" ").

Заметки

Тег <paramref> позволяет указать, что слово в комментариях кода, например в блоке <summary> или <remarks>, ссылается на параметр. Чтобы форматировать это слово некоторым конкретным образом, например выделить курсивом или жирным, может быть обработан XML-файл.

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

Пример

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.  
    /// The <paramref name="Int1"/> parameter takes a number.
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

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

См. также

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

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

Ссылки

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