Udostępnij za pośrednictwem


<param> (Visual C++)

<param> Tag stosuje się w komentarz dotyczący deklaracji metody do opisywania jeden z parametrów dla metody.

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

Parametry

  • name
    Nazwa parametr metody.Nazwę ująć w pojedynczy lub podwójny cudzysłów.Kompilator generuje ostrzeżenie, jeśli nie znajdzie name.

  • description
    Opis dla parametru.

Uwagi

Tekst dla <param> tag będzie wyświetlany w technologii IntelliSense, Przeglądarka obiektówi w sprawozdaniu Web kod komentarza.

Kompilacji z /doc do procesu komentarzy dokumentacji do pliku.

Przykład

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

Zobacz też

Inne zasoby

Dokumentacja XML (Visual C++)