Dokumentace kódu s XML (Visual Basic)
V Visual Basic, můžete dokument XML pomocí kódu
Komentáře XML dokumentace
Visual Basicposkytuje snadno vytvořit automaticky dokumentace XML pro projekty.Automaticky generovat kostra XML pro typy a členy a pak poskytují shrnutí, popisná dokumentace pro každý parametr a jiné poznámky.Vhodné nastavení je dokumentace XML automaticky vyzařovaného do souboru XML s názvem projektu a příponu XML.Další informace naleznete v tématu /doc.
Soubor XML můžete spotřebovány nebo jinak manipulovat jako XML.Tento soubor je umístěn ve stejném adresáři jako soubor s příponou EXE nebo DLL výstup projektu.
Dokumentace XML začíná '''.Zpracování těchto poznámek má některá omezení:
Dokumentace musí být ve správném formátu XML.Pokud XML není správně utvořen, je generována upozornění a soubor dokumentace obsahuje komentář, oznamující, že došlo k chybě.
Vývojáři mohou vytvořit vlastní sadu tagů.Je doporučeno sadou tagů (viz "Související oddíly" v tomto tématu).Některé doporučené značky mají speciální význam:
<param> značka se používá k popisu parametrů.Pokud, kompilátor bude ověřovat, že parametr existuje a že všechny parametry jsou popsány v dokumentaci.Pokud se ověření nezdaří, kompilátoru upozornění.
cref Atribut lze připojit k libovolné značky poskytnout odkaz na element kódu.Kompilátor ověří, zda existuje tento prvek kódu.Pokud se ověření nezdaří, kompilátoru upozornění.Kompilátor také dodržuje všechny Imports příkazy, když hledáte typu popsaného v cref atributu.
<summary> značka používá technologie IntelliSense v Visual Studio zobrazíte další informace o typu nebo člena.
Související oddíly
Podrobnosti o vytvoření souboru XML s komentáři dokumentaci naleznete v následujících tématech: