-Doc
Hiermee worden documentatieopmerkingen naar een XML-bestand verwerkt.
Syntaxis
-doc[+ | -]
or
-doc:file
Argumenten
| Term | Definitie |
|---|---|
+ | - |
Optioneel. Als u +, of alleen -doc, opgeeft, genereert de compiler documentatie-informatie en plaatst u deze in een XML-bestand. - Opgeven is het equivalent van het niet opgeven-doc, waardoor er geen documentatiegegevens worden gemaakt. |
file |
Vereist indien -doc: gebruikt. Hiermee geeft u het XML-uitvoerbestand op, dat wordt gevuld met de opmerkingen uit de broncodebestanden van de compilatie. Als de bestandsnaam een spatie bevat, plaatst u de naam tussen aanhalingstekens (" "). |
Opmerkingen
Met -doc de optie bepaalt u of de compiler een XML-bestand genereert met de opmerkingen bij de documentatie. Als u de -doc:file syntaxis gebruikt, geeft de file parameter de naam van het XML-bestand op. Als u dit gebruikt -doc of -doc+, neemt de compiler de naam van het XML-bestand of de uitvoerbare bibliotheek op die door de compiler wordt gemaakt. Als u de -doc optie gebruikt -doc- of niet opgeeft, maakt de compiler geen XML-bestand.
In broncodebestanden kunnen documentatieopmerkingen voorafgaan aan de volgende definities:
Door de gebruiker gedefinieerde typen, zoals een klasse of interface
Leden, zoals een veld, gebeurtenis, eigenschap, functie of subroutine.
Als u het gegenereerde XML-bestand wilt gebruiken met de functie Visual Studio IntelliSense , laat u de bestandsnaam van het XML-bestand hetzelfde zijn als de assembly die u wilt ondersteunen. Zorg ervoor dat het XML-bestand zich in dezelfde map bevindt als de assembly, zodat het .xml bestand ook wordt gevonden wanneer de assembly in het Visual Studio-project wordt verwezen. XML-documentatiebestanden zijn niet vereist om intelliSense te kunnen werken voor code binnen een project of binnen projecten waarnaar wordt verwezen door een project.
Tenzij u compileert met -target:module, bevat het XML-bestand de tags <assembly></assembly>. Met deze tags geeft u de naam op van het bestand met het assemblymanifest voor het uitvoerbestand van de compilatie.
Zie XML-opmerkingstags voor manieren om documentatie te genereren op basis van opmerkingen in uw code.
| -doc instellen in de geïntegreerde ontwikkelomgeving van Visual Studio |
|---|
| 1. Laat een project selecteren in Solution Explorer. Klik in het menu Project op Eigenschappen. 2. Klik op het tabblad Compileren . 3. Stel de waarde in het vak XML-documentatiebestand genereren in. |
Opmerking
Zie Uw code documenteren met XML voor een voorbeeld.
