<param> (Visual C++)
Тег <param> должен использоваться в комментариях объявления метода для описания его параметров.
<param name='name'>description</param>
Параметры
name
Имя параметра метода.Заключить его в одинарные или двойные кавычки.Компилятор выдает предупреждение, если не удается найти name.description
Описание для параметра.
Заметки
Текст для тега <param> будет отображаться в IntelliSense, Обозреватель объектов и в веб-отчет комментариев кода.
Чтобы обработать и сохранить комментарии документации в файл, при компиляции необходимо использовать параметр /doc.
Пример
// xml_param_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_param_tag.dll
/// Text for class MyClass.
public ref class MyClass {
/// <param name="Int1">Used to indicate status.</param>
void MyMethod(int Int1) {
}
};