<param> tag dokumentacji
Tag <param> powinien być używany w komentarzu dla deklaracji metody, aby opisać jeden z parametrów metody.
Składnia
/// <param name='param-name'>description</param>
Parametry
param-name
Nazwa parametru metody. Ujęć nazwę w pojedynczych lub podwójnych cudzysłowach. Kompilator wyświetla ostrzeżenie, jeśli nie znajdzie param-nameelementu .
description
Opis parametru.
Uwagi
Tekst tagu <param> będzie wyświetlany w funkcji IntelliSense, przeglądarce obiektów i w raporcie sieci Web komentarza kodu.
Skompiluj element , /doc aby przetworzyć komentarze 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) {
}
};