<see> (Przewodnik programowania w języku C#)

  • Artykuł
<see cref="member"/>

Parametry

  • cref = " member"
    Odwołanie do członka lub pola, które jest dostępne na wywoływanie z bieżącego środowiska kompilacji.Kompilator sprawdza, czy dany kod element istnieje i przekazuje member do nazwy elementu w danych wyjściowych XML.Miejsce Członkowskich w znaki cudzysłowu ("").

Uwagi

<Zobacz> należy określić łącze z wewnątrz tekstu.Użycie <seealso> , aby wskazać, że tekst należy umieścić w sekcji Zobacz też.Użycie atrybut cref stworzyć wewnętrzne hiperłącza do stron dokumentacji dla elementów kodu.

Kompiluj z /doc do komentarzy dokumentacji procesu do pliku.

W poniższym przykładzie pokazano <zobacz> tag w sekcji podsumowania.

// compile with: /doc:DocFileName.xml  

/// text for class TestClass 
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class. 
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary> 
    public static void DoWork(int Int1)
    {
    }

    /// text for Main 
    static void Main()
    {
    }
}

Zobacz też

Informacje

Znaczniki zalecane dla komentarzy do dokumentacji (Przewodnik programowania w języku C#)

Koncepcje

Przewodnik programowania w języku C#