Aracılığıyla paylaş

<param> belge etiketi

  • Makale

etiketi, <param> yöntemin parametrelerinden birini açıklamak üzere bir yöntem bildiriminin açıklamasında kullanılmalıdır.

Sözdizimi

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

Parametreler

param-name
Yöntem parametresinin adı. Adı tek veya çift tırnak içine alın. Derleyici, bulamazsa param-namebir uyarı oluşturur.

description
parametresi için bir açıklama.

Açıklamalar

Etiketin <param> metni IntelliSense, Nesne Tarayıcısı ve Kod Açıklaması Web Raporu'nda görüntülenir.

Bir dosyaya belge açıklamalarını işlemek için ile derleyin /doc .

Örnek

// 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) {
   }
};

Ayrıca bkz.

XML belgeleri