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

<paramref> тег документации

  • Статья

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

Синтаксис

/// <paramref name="ref-name"/>

Параметры

ref-name
Имя параметра, на который указывается ссылка. Заключите имя в одинарные или двойные кавычки. Компилятор выдает предупреждение, если он не находит ref-name.

Замечания

Скомпилируйте их для /doc обработки примечаний документации к файлу.

Пример

// xml_paramref_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_paramref_tag.dll
/// Text for class MyClass.
public ref class MyClass {
   /// <summary>MyMethod is a method in the MyClass class.
   /// The <paramref name="Int1"/> parameter takes a number.
   /// </summary>
   void MyMethod(int Int1) {}
};

См. также

XML-документация