/doc (C# kompilator opcje)
/doc Opcja pozwala umieszczać komentarzy dokumentacji w pliku XML.
/doc:file
Argumenty
- file
Pliku wyjściowego w formacie XML, która jest wypełniona komentarzy w plikach kodu źródłowego kompilacji.
Uwagi
W pliki kodu źródłowego mogą być przetwarzane i dodane do pliku XML komentarzy dokumentacji, które poprzedzają następujące czynności:
Takie typy zdefiniowane przez użytkownika jako klasy, delegować, lub interfejsu
Takich członków jako pole, zdarzenia, Właściwość, lub metody
Plik kodu źródłowego, zawierającą głównego najpierw są kierowane do pliku XML.
Aby użyć pliku XML wygenerowanego do użytku z IntelliSense funkcji, niech pliku nazwa pliku .xml, być taka sama jak zgromadzenie chcesz obsługiwać, a następnie upewnij się plik XML jest w tym samym katalogu co zgromadzenie.W ten sposób zgromadzenie odwołuje się projekt programu Visual Studio, pliku XML znajduje się także.Zobacz Dostarczanie komentarzy do kodu i uzyskać więcej informacji.
Chyba że kompilacji z /target:module, file będzie zawierać <assembly> </assembly> znaczniki, określający nazwę pliku zawierającego manifestu zestawu kompilacji pliku wyjściowego.
[!UWAGA]
Opcja /doc stosuje się do wszystkich plików wejściowych; lub, jeśli określone w ustawieniach projektu, wszystkie pliki w projekcie.Aby wyłączyć ostrzeżenia dotyczące komentarzy dokumentacji dla określonego pliku lub sekcji kodu, należy użyć Ostrzeżenie # pragma.
Zobacz Zalecane znaczniki komentarzy dokumentacji dla sposoby generowania dokumentacji z uwagi na swój kod.
Aby ustawić tę opcję kompilatora w środowisku projektowym programu Visual Studio
Otwórz projekt Właściwości strony.
Kliknij przycisk budować kartę.
Modyfikowanie Plik dokumentacji XML właściwości.
Aby uzyskać informacje dotyczące sposobu ustawiania tej opcji kompilatora programowo, zobacz DocumentationFile.
Zobacz też
Zadania
Jak: modyfikowanie właściwości projektu i ustawień konfiguracji