Komentarze dokumentacji XML (Przewodnik programowania w języku C#)
W języku Visual C# można tworzyć dokumentację kodu, umieszczając elementy XML w specjalnych polach komentarzy (wskazywanych przez potrójne ukośniki) w kodzie źródłowym bezpośrednio przed blokiem kodu, do którego odwołują się komentarze, na przykład:
/// <summary>
/// This class performs an important function.
/// </summary>
public class MyClass{}
Podczas kompilacji z użyciem opcji /doc kompilator będzie wyszukiwał wszystkie tagi XML w kodzie źródłowym i tworzył plik dokumentacji w formacie XML.Aby na podstawie pliku wygenerowanego przez kompilator utworzyć finalną dokumentację, można utworzyć narzędzie niestandardowe albo użyć dostępnego narzędzia, takiego jak Sandcastle.
Aby odwoływać się do elementów XML (na przykład funkcja przetwarza określone elementy XML, które użytkownik chce opisać w komentarzu dokumentacji XML), można użyć standardowego mechanizmu cytowania (< i >). Aby w elementach odwołania do kodu (cref) odwoływać się do identyfikatorów ogólnych, można użyć znaków ucieczki (na przykład cref=”List<T>”) lub nawiasów klamrowych (cref=”List{T}”). Jest to szczególny przypadek, w którym kompilator analizuje nawiasy klamrowe jako nawiasy kątowe, dzięki czemu komentarz dokumentacji jest wygodniejszy dla autora, gdy ten odwołuje się do identyfikatorów ogólnych.
[!UWAGA]
Komentarze dokumentacji XML nie są metadanymi; nie są one uwzględniane w kompilowanym zestawie i dlatego są niedostępne za pośrednictwem mechanizmu odbicia.
W tej sekcji
Sekcje pokrewne
Aby uzyskać więcej informacji, zobacz:
Specyfikacja języka C#
Aby uzyskać więcej informacji, zobacz Specyfikacja języka C#. Specyfikacja języka jest ostatecznym źródłem informacji o składni i użyciu języka C#.