Ajánlott XML-címkék dokumentációs megjegyzésekhez (Visual Basic)

A Visual Basic fordítója feldolgozhatja a kódban lévő dokumentáció megjegyzéseit egy XML-fájlba. További eszközökkel feldolgozhatja az XML-fájlt a dokumentációban.

Xml-megjegyzések engedélyezettek a kódszerkezeteken, például a típusokon és a típustagokon. Részleges típusok esetén a típusnak csak egy része rendelkezhet XML-megjegyzésekkel, bár a tagok megjegyzéseinek megjegyzésére nincs korlátozás.

Megjegyzés:

A dokumentáció megjegyzései nem alkalmazhatók névterekre. Ennek az az oka, hogy egy névtér több szerelvényre is kiterjedhet, és nem minden szerelvényt kell egyszerre betölteni.

A fordító minden érvényes XML-címkét feldolgoz. A következő címkék a felhasználói dokumentációban gyakran használt funkciókat tartalmazzák.

• <c>
• <kód>
• <példa>
• <1. kivétel>
• <1 belefoglalása>
• <lista>
• <para>
• <param>¹
• <paramref>
• <engedély>¹
• <Megjegyzések>
• <Visszatér>
• <lásd:>¹
• <seealso>¹
• <összefoglalás>
• <typeparam>¹
• <typeparamref>
• <érték>

(¹ A fordító ellenőrzi a szintaxist.)

Megjegyzés:

Ha azt szeretné, hogy szögletes zárójelek jelenjenek meg egy dokumentációs megjegyzés szövegében, használja < a >és a . A sztring "<text in angle brackets>" például a következőképpen jelenik meg <text in angle brackets>: .

Lásd még

• Kód dokumentálása XML-lel
• -Doc
• Útmutató: XML-dokumentáció létrehozása