Dokumentační komentáře XML (Průvodce programováním v C#)
V jazyce Visual C# můžete vytvářet dokumentaci ke kódu zadáním prvků XML do zvláštních polí komentáře (označeno třemi lomítky) ve zdrojovém kódu přímo před blok kódu, na který se komentáře vztahují, například:
/// <summary>
/// This class performs an important function.
/// </summary>
public class MyClass{}
Při sestavování pomocí možnosti /doc začne kompilátor vyhledávat všechny značky XML ve zdrojovém kódu a vytvoří soubor dokumentace XML.Chcete-li vytvořit finální dokumentaci na základě souboru generovaného kompilátorem, můžete si vytvořit vlastní nástroj nebo použít nástroj, jako je Sandcastle.
Chcete-li vytvořit odkaz na prvky XML (vaše funkce například zpracovává konkrétní prvky, které chcete popsat v komentáři dokumentace jazyka XML), můžete použít standardní mechanismus citací (< a >). Chcete-li vytvořit odkaz na obecné identifikátory v prvcích odkazu kódu (cref), můžete použít buď řídicí znaky (například cref=”List<T>”), nebo složené závorky (cref=”List{T}”). Ve zvláštním případě kompilátor analyzuje složené závorky jako lomené závorky, a to proto, aby komentáře v dokumentaci nebyly pro autora při vytváření odkazů na obecné identifikátory tak složité.
[!POZNÁMKA]
Komentáře dokumentace XML nejsou metadata; nejsou zahrnuty ve zkompilovaném sestavení, a proto nejsou přístupné prostřednictvím reflexe.
V tomto oddílu
Související oddíly
Další informace naleznete v tématu:
Specifikace jazyka C#
Další informace najdete v tématu Specifikace jazyka C#. Specifikace jazyka je úplným a rozhodujícím zdrojem pro syntaxi a použití jazyka C#.