Komentáře XML dokumentace (Příručka programování C#)

V aplikaci Visual C# můžete vytvořit dokumentaci kódu včetně značky XML v polích zvláštní poznámky ve zdrojovém kódu přímo před bloku kódu, na které odkazují.Příklad:

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

Při sestavování s /doc kompilátor bude hledat všechny značky XML v zdrojový kód a vytvořit soubor dokumentace XML.Vytvoření konečné dokumentace založený na souboru generovaných kompilátorem, můžete vytvořit vlastní nástroj nebo nástroj jako Sandcastle.

[!POZNÁMKA]

Komentáře XML dokumentu nejsou metadata; nejsou zahrnuty v kompilovaném sestavení a proto nejsou přístupné prostřednictvím reflexe.

V tomto oddíle

• Doporučené značky pro dokumentaci komentáře

• Zpracování souboru XML

• Oddělovače pro dokumentaci značky

• Jak: použití funkcí dokumentace XML

Související oddíly

Více informací naleznete:

• /DOC (komentáře dokumentaci procesu)

Specifikace jazyka C#

Další informace naleznete v tématu Specifikace jazyka C#. Specifikace jazyka je úplným a rozhodujícím zdrojem pro syntaxi a použití jazyka C#.

Viz také

Koncepty

Příručka programování C#