<paramref> (Visual C++)
Тег <paramref> дает возможность указать, что параметр ключевое слово.Xml-файл можно обработать, чтобы отформатировать этот параметр каким-либо определенным образом.
<paramref name="name"/>
Параметры
- name
Имя параметра, на который нужна ссылка.Заключить его в одинарные или двойные кавычки.Компилятор выдает предупреждение, если не удается найти 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) {}
};