<see> tag dokumentacji

Tag <see> umożliwia określenie linku z poziomu tekstu. Użyj <seealso> polecenia , aby wskazać tekst, który może być wyświetlany w sekcji Zobacz również .

Składnia

/// <see cref="member"/>

Parametry

member
Odwołanie do elementu członkowskiego lub pola, które jest dostępne do wywołania z bieżącego środowiska kompilacji. Ujęć nazwę w pojedynczych lub podwójnych cudzysłowach.

Kompilator sprawdza, czy dany element kodu istnieje i rozpoznaje member nazwę elementu w wyjściowym pliku XML. Kompilator wyświetla ostrzeżenie, jeśli nie znajdzie memberelementu .

Uwagi

Skompiluj element , /doc aby przetworzyć komentarze dokumentacji do pliku.

Przykład użycia elementu <see>można znaleźć w temacie <summary>.

Kompilator MSVC podejmie próbę rozpoznania cref odwołań w jednym przekazaniu komentarzy dokumentacji. Jeśli kompilator nie znajdzie symbolu podczas korzystania z reguł odnośników języka C++, oznacza odwołanie jako nierozwiązane. Aby uzyskać więcej informacji, zobacz <seealso>.

Przykład

Poniższy przykład pokazuje, jak można odwoływać się cref do typu ogólnego, aby kompilator rozpoznał odwołanie.

// xml_see_cref_example.cpp
// compile with: /LD /clr /doc
// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <see cref="C{T}">
/// </see>
ref class A {};

// the following cref shows another way to specify the reference,
// such that, the compiler will resolve the reference
/// <see cref="C < T >"/>

// the following cref shows how to hard-code the reference
/// <see cref="T:C`1">
/// </see>
ref class B {};

/// <see cref="A">
/// </see>
/// <typeparam name="T"></typeparam>
generic<class T>
ref class C {};

Zobacz też

Dokumentacja XML