Útmutató: XML-dokumentáció létrehozása a Visual Basicben

Ez a példa bemutatja, hogyan adhat hozzá XML-dokumentációs megjegyzéseket a kódhoz.

Megjegyzés:

Előfordulhat, hogy a számítógép különböző neveket vagy helyeket jelenít meg a Visual Studio felhasználói felületének egyes elemeihez az alábbi utasításokban. Ezeket az elemeket a Visual Studio-kiadás és a használt beállítások határozzák meg. További információért lásd: A fejlesztői környezet személyre szabása.

XML-dokumentáció létrehozása egy típushoz vagy taghoz

1. A Kódszerkesztőben helyezze a kurzort arra a típusra vagy tagra, amelyhez dokumentációt szeretne létrehozni.

2. Írja be ''' (három egyszeres idézőjel).

   A kódszerkesztő egy XML-csontvázat ad hozzá a típushoz vagy taghoz.

3. Adjon hozzá leíró információkat a megfelelő címkék között.

   Megjegyzés:

   Ha további sorokat ad hozzá az XML dokumentációs blokkjában, minden sornak a következővel '''kell kezdődnie: .

4. Adjon hozzá további kódot, amely a típust vagy tagot használja az új XML-dokumentáció megjegyzéseivel.

   Az IntelliSense megjeleníti a típus vagy tag címkéjének <summary> szövegét.

5. Állítsa össze a kódot a dokumentáció megjegyzéseit tartalmazó XML-fájl létrehozásához. További információ: -doc.

Lásd még

• Kód dokumentálása XML-lel
• XML-megjegyzéscímkék
• -Doc