/doc
Przetwarza komentarzy dokumentacji do pliku XML.
/doc[+ | -]
' -or-
/doc:file
Argumenty
Termin |
Definicja |
+ | - |
Opcjonalne.Określanie +, lub po prostu /doc, powoduje, że kompilator może wygenerować informacji o dokumentacji i umieścić ją w pliku XML.Określanie - jest to równoważne wpisaniu nie /doc, powodując żadnych informacji w dokumentacji ma zostać utworzony. |
file |
Wymagany, jeżeli /doc: jest używana.Określa plik XML wyjściowy jest wypełniona komentarze z plików kodu źródłowego kompilacji.Jeśli w nazwie pliku znajdują się spacje, należy ująć nazwę w cudzysłów (""). |
Uwagi
/doc Opcji kontroli, czy kompilator generuje plik XML zawierający komentarze dokumentacji.Jeśli korzystasz z /doc:file składni, file parametr określa nazwę pliku XML.Jeśli korzystasz z /doc lub /doc+, kompilator ma nazwę pliku XML z pliku wykonywalnego lub biblioteki, który tworzy kompilator.Jeśli korzystasz z /doc- lub nie określaj /doc opcji, kompilator nie tworzy pliku XML.
W plikach kodu źródłowego komentarzy dokumentacji może poprzedzać następujące definicje:
Zdefiniowane przez użytkownika typów, takich jak klasy lub interfejsu
Członkowie, takie jak pola, zdarzenia, Właściwość, funkcji, lub podprocedury.
Aby użyć wygenerowany plik XML z Visual StudioIntelliSense funkcji, niech nazwę pliku pliku XML, być taka sama jak zgromadzenie ma być obsługiwana. Upewnić się, że plik XML jest w tym samym katalogu co zgromadzenie tak, że gdy odwołuje się zgromadzenie Visual Studio projektu, pliku XML znajduje się także.Pliki dokumentacji XML nie są wymagane dla IntelliSense pracy dla kodu w ramach projektu lub projektów odwołuje się projekt.
Chyba że kompilacji z /target:module, plik XML zawiera tagi <assembly></assembly>.Te znaczniki określ nazwę pliku zawierającego manifestu zestawu kompilacji pliku wyjściowego.
Zobacz Zalecane tagi XML dla komentarzy dokumentacji (Visual Basic) dla sposoby generowania dokumentacji z uwagi na swój kod.
Aby ustawić /doc w programie Visual Studio zintegrowanego środowiska programowania |
|
Przykład
Zobacz Dokumentowanie kodu za pomocą XML (Visual Basic) dla próbki.
Zobacz też
Koncepcje
Dokumentowanie kodu za pomocą XML (Visual Basic)