-doc
Przetwarza komentarze dokumentacji do pliku XML.
Składnia
-doc[+ | -]
lub
-doc:file
Argumenty
| Termin | Definicja |
|---|---|
+ | - |
Opcjonalny. Określenie +, lub tylko -doc, powoduje, że kompilator generuje informacje o dokumentacji i umieszcza je w pliku XML. Określenie - jest odpowiednikiem nieokreślizowania -docelementu , co nie powoduje utworzenia żadnych informacji o dokumentacji. |
file |
Wymagane, jeśli -doc: jest używany. Określa wyjściowy plik XML, który jest wypełniany komentarzami z plików kodu źródłowego kompilacji. Jeśli nazwa pliku zawiera spację, umieść nazwę znakiem cudzysłowu (" "). |
Uwagi
Opcja -doc określa, czy kompilator generuje plik XML zawierający komentarze dokumentacji. Jeśli używasz -doc:file składni, file parametr określa nazwę pliku XML. Jeśli używasz -doc polecenia lub -doc+, kompilator przyjmuje nazwę pliku XML z pliku wykonywalnego lub biblioteki tworzonej przez kompilator. Jeśli używasz -doc- opcji lub nie określisz -doc tej opcji, kompilator nie tworzy pliku XML.
W plikach kodu źródłowego komentarze dokumentacji mogą poprzedzać następujące definicje:
Typy zdefiniowane przez użytkownika, takie jak klasa lub interfejs
Elementy członkowskie, takie jak pole, zdarzenie, właściwość, funkcja lub podroutyna.
Aby użyć wygenerowanego pliku XML z funkcją IntelliSense programu Visual Studio, niech nazwa pliku XML będzie taka sama jak zestaw, który chcesz obsługiwać. Upewnij się, że plik XML znajduje się w tym samym katalogu co zestaw, tak aby po odwołaniu się do zestawu w projekcie programu Visual Studio plik .xml również został znaleziony. Pliki dokumentacji XML nie są wymagane, aby funkcja IntelliSense działała w kodzie w projekcie lub w projektach, do których odwołuje się projekt.
O ile plik XML nie zostanie skompilowany przy -target:moduleużyciu polecenia , zawiera tagi <assembly></assembly>. Te tagi określają nazwę pliku zawierającego manifest zestawu dla pliku wyjściowego kompilacji.
Zobacz Tagi komentarzy XML, aby poznać sposoby generowania dokumentacji z komentarzy w kodzie.
| Aby ustawić dokument w zintegrowanym środowisku projektowym programu Visual Studio |
|---|
| 1. Wybierz projekt w Eksplorator rozwiązań. W menu Project (Projekt) kliknij pozycję Properties (Właściwości). 2. Kliknij kartę Kompiluj. 3. Ustaw wartość w polu Generowanie pliku dokumentacji XML. |
Przykład
Zobacz Dokumentowanie kodu przy użyciu kodu XML , aby zapoznać się z przykładem.
