Kód dokumentálása XML-fájllal (Visual Basic)

  • Cikk

A Visual Basicben XML használatával dokumentálhatja a kódot.

XML-dokumentáció megjegyzései

A Visual Basic egyszerű módot kínál a projektek XML-dokumentációjának automatikus létrehozására. Automatikusan létrehozhat egy XML-csontvázat a típusok és tagok számára, majd az egyes paraméterekhez összefoglalókat, leíró dokumentációt és egyéb megjegyzéseket adhat meg. A megfelelő beállítással az XML-dokumentáció automatikusan ki lesz bocsátva egy olyan XML-fájlba, amely ugyanazzal a gyökérfájlnévvel rendelkezik, mint a projekt. Az XML-dokumentációs fájl létrehozásának konfigurálásáról további információt a -doc compiler ésa GenerateDocumentationFile MSBuild tulajdonságban talál.

Az XML-fájl felhasználható vagy más módon módosítható XML-fájlként. Ez a fájl ugyanabban a könyvtárban található, mint a projekt kimeneti .exe vagy .dll fájlja.

Az XML-dokumentáció a következővel '''kezdődik: . A megjegyzések feldolgozása bizonyos korlátozásokkal rendelkezik:

  • A dokumentációnak megfelelően formázott XML-nek kell lennie. Ha az XML nem megfelelően formázott, figyelmeztetés jön létre, és a dokumentációs fájl egy megjegyzést tartalmaz, amely szerint hiba történt.

  • A fejlesztők szabadon hozhatnak létre saját címkéket. A címkék ajánlott készlete (lásd : XML-megjegyzéscímkék). Néhány ajánlott címke különleges jelentéssel rendelkezik:

    • A <paramétercímke> a paraméterek leírására szolgál. Használat esetén a fordító ellenőrzi, hogy létezik-e a paraméter, és hogy az összes paraméter szerepel-e a dokumentációban. Ha az ellenőrzés sikertelen, a fordító figyelmeztetést ad ki.

    • Az cref attribútum bármely címkéhez csatolható, hogy egy kódelemre hivatkozzon. A fordító ellenőrzi, hogy létezik-e ez a kódelem. Ha az ellenőrzés sikertelen, a fordító figyelmeztetést ad ki. A fordító az attribútumban leírt típus keresésekor minden utasítást cref tiszteletben tartImports.

    • Az <összefoglaló> címkét az IntelliSense használja a Visual Studióban, hogy további információkat jelenítsen meg egy típusról vagy tagról.

Az XML-fájlok dokumentációs megjegyzésekkel való létrehozásával kapcsolatos részletekért tekintse meg az alábbi témaköröket:

Lásd még