Komentarzy dokumentacji XML (Podręcznik programowania C#)

W środowisku Visual C# można utworzyć dokumentacji kodu w tym tagi XML w dziedzinach specjalny komentarz w kodzie źródłowym bezpośrednio przed blok kodu, które odnoszą się do.Na przykład:

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

Podczas kompilacji z /doc kompilator będzie wyszukiwać wszystkie tagi języka XML źródła kodu i utworzyć plik dokumentacji XML.Aby utworzyć ostatniej dokumentacji, na podstawie plików generowanych przez kompilator, można tworzyć niestandardowe narzędzie, lub użyć narzędzia, takie jak Sandcastle.

[!UWAGA]

Doc komentarze nie są metadane; nie są uwzględniane w skompilowanym zestawie i dlatego nie są one dostępne za pośrednictwem odbicia.

W tej sekcji

• Zalecane znaczniki komentarzy dokumentacji

• Przetwarzanie pliku XML

• Ograniczniki dokumentacji znaczników

• Jak: Użyj funkcji dokumentacji XML

Sekcje pokrewne

Aby uzyskać więcej informacji zobacz:

• /doc (proces komentarzy dokumentacji)

Specyfikacja języka C#

Aby uzyskać więcej informacji, zobacz Specyfikacja języka C#. Specyfikacja języka to najlepsze źródło informacji dotyczących składni i zastosowania języka C#.

Zobacz też

Koncepcje

Podręcznik programowania C#