Megosztás a következőn keresztül:

-Bizonylat

  • Cikk

Feldolgozza egy XML-fájl dokumentációs megjegyzéseit.

Syntax

-doc[+ | -]

vagy

-doc:file

Argumentumok

Időszak Definíció
+ | - Opcionális. A +vagy csak -docparancs megadásával a fordító dokumentációs információkat hoz létre és elhelyez egy XML-fájlban. A beállítás - egyenértékű azzal, ha nem adja meg -doc, és nem hoz létre dokumentációs adatokat.
file Használat esetén -doc: kötelező megadni. Megadja a kimeneti XML-fájlt, amely a fordítás forráskódfájljainak megjegyzéseivel van feltöltve. Ha a fájlnév szóközt tartalmaz, a nevet idézőjelekkel (" ") kell körülvenni.

Megjegyzések

A -doc beállítás azt szabályozza, hogy a fordító létrehoz-e a dokumentáció megjegyzéseit tartalmazó XML-fájlt. Ha a szintaxist -doc:file használja, a file paraméter az XML-fájl nevét adja meg. Ha használja -doc vagy -doc+, a fordító a fordító által létrehozott végrehajtható fájlból vagy tárból veszi át az XML-fájl nevét. Ha használja -doc- vagy nem adja meg a -doc beállítást, a fordító nem hoz létre XML-fájlt.

A forráskódfájlokban a dokumentáció megjegyzései megelőzhetik a következő definíciókat:

Ha a létrehozott XML-fájlt a Visual Studio IntelliSense szolgáltatással szeretné használni, hagyja, hogy az XML-fájl neve megegyezzon a támogatni kívánt szerelvény nevével. Győződjön meg arról, hogy az XML-fájl ugyanabban a könyvtárban található, mint a szerelvény, hogy amikor a szerelvényre hivatkozik a Visual Studio-projektben, a .xml fájl is megtalálható legyen. Az XML-dokumentációs fájlok nem szükségesek ahhoz, hogy az IntelliSense kódokat dolgozzon egy projekten belül vagy egy projekt által hivatkozott projekteken belül.

Ha nem fordítja le -target:module, az XML-fájl tartalmazza a címkéket <assembly></assembly>. Ezek a címkék adják meg annak a fájlnak a nevét, amely tartalmazza a fordítás kimeneti fájljának szerelvényjegyzékét.

A kód megjegyzéseiből származó dokumentáció létrehozásának módjaiért tekintse meg az XML-megjegyzések címkéit .

A -doc beállítása a Visual Studio integrált fejlesztési környezetében
1. Válasszon ki egy projektet Megoldáskezelő. A Projekt menüben kattintson a Tulajdonságok elemre.
2. Kattintson a Fordítás fülre.
3. Állítsa be az értéket az XML-dokumentációs fájl létrehozása mezőben.

Példa

Tekintse meg a kód xml-fájllal történő dokumentálását a mintához.

Lásd még