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

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

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

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ó feldolgoz minden érvényes XML-címkét. Az alábbi címkék általánosan használt funkciókat biztosítanak a felhasználói dokumentációban.

• <C>
• <Kód>
• <Példa>
• <exception1>
• <include1>
• <Lista>
• <Para>
• <param1>
• <paramref>
• <engedély1>
• <Megjegyzések>
• <Visszatér>
• <lásd>^{: 1}
• <seealso1>
• <Összefoglaló>
• <typeparam1>
• <É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