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


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

Тег <param> следует использовать в комментариях к объявлению метода для описания одного из параметров такого метода.

Синтаксис

/// <param name='param-name'>description</param>

Параметры

param-name
Имя параметра метода. Заключите имя в одинарные или двойные кавычки. Компилятор выдает предупреждение, если он не находит param-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) {
   }
};

См. также

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