Sdílet prostřednictvím

Zdokumentujte kód pomocí KÓDU XML (Visual Basic)

  • Článek

V jazyce Visual Basic můžete dokumentovat kód pomocí xml.

Komentáře dokumentace XML

Visual Basic nabízí snadný způsob, jak automaticky vytvořit dokumentaci XML pro projekty. Můžete automaticky vygenerovat kostru XML pro vaše typy a členy a pak zadat souhrny, popisnou dokumentaci pro každý parametr a další poznámky. Při vhodném nastavení se dokumentace XML automaticky vygeneruje do souboru XML se stejným názvem kořenového souboru jako váš projekt. Informace o konfiguraci generování souboru dokumentace XML naleznete v -doc compiler option and GenerateDocumentationFile MSBuild vlastnost.

Soubor XML může být využit nebo jinak manipulován jako XML. Tento soubor se nachází ve stejném adresáři jako výstupní .exe nebo .dll soubor projektu.

Dokumentace XML začíná na '''. Zpracování těchto komentářů má určitá omezení:

  • Dokumentace musí být ve správném formátu XML. Pokud xml není správně vytvořený, vygeneruje se upozornění a soubor dokumentace obsahuje komentář s informací, že došlo k chybě.

  • Vývojáři mohou vytvářet vlastní sadu značek. K dispozici je doporučená sada značek (viz značky komentářů XML). Některé z doporučených značek mají zvláštní význam:

    • Značka parametru <> slouží k popisu parametrů. Pokud se použije, kompilátor ověří, že parametr existuje a že jsou všechny parametry popsané v dokumentaci. Pokud se ověření nezdaří, kompilátor vydá upozornění.

    • Atribut cref lze připojit k jakékoli značce, která poskytuje odkaz na prvek kódu. Kompilátor ověří, že tento prvek kódu existuje. Pokud se ověření nezdaří, kompilátor vydá upozornění. Kompilátor také respektuje všechny Imports příkazy při hledání typu popsaného v atributu cref .

    • > Souhrnnou <značku používá IntelliSense v sadě Visual Studio k zobrazení dalších informací o typu nebo členu.

Podrobnosti o vytvoření souboru XML s komentáři k dokumentaci najdete v následujících tématech:

Viz také