C# 3.0. Leksykon kieszonkowy. Wydanie II

Dokumentacja XML

Komentarz dokumentujący to fragment osadzonego w kodzie źródłowym kodu XML służącego do udokumentowania typu albo składowej. Komentarz dokumentujący powinien znajdować się tuż przed deklaracją typu bądź składowej typu i zaczynać się od trzech ukośników:

/// <summary>Odwołuje wykonywane zapytanie.</summary>
public void Cancel() { ... }

Komentarze dokumentujące mogą być komentarzami wielowierszowymi, jak tutaj:

/// <summary>
/// Odwołuje wykonywane zapytanie.
/// </summary>
public void Cancel() { ... }

Można też zastosować specjalną składnię wielowierszowego komentarza dokumentującego (z dodatkową gwiazdką):

/**
    <summary>Odwołuje wykonywane zapytanie.</summary>
*/
public void Cancel() { ... }

Jeśli taki kod skompilujemy z przełącznikiem ...