Wyświetlanie, zapisywanie i konfigurowanie plików dziennika kompilacji

Po skompilowaniu projektu w interaktywnym środowisku projektowym programu Visual Studio można wyświetlić zarejestrowane informacje o kompilacji w oknie Dane wyjściowe programu Visual Studio. Dane wyjściowe można zapisywać w plikach dziennika, które można wyświetlać w programie Visual Studio i innych edytorach.

Dzienniki mogą pomóc w rozwiązywaniu problemów w kompilacji. Możesz zlokalizować dokładne wiersze polecenia używane dla wszystkich narzędzi kompilacji i uzyskać pełne dane diagnostyczne dotyczące całego procesu kompilacji. Program Visual Studio udostępnia opcje określania rodzajów informacji, które mają być widoczne w danych wyjściowych kompilacji i plikach dziennika kompilacji.

W tym artykule opisano sposób generowania, konfigurowania i wyświetlania plików dziennika kompilacji w programie Visual Studio.

Generowanie i wyświetlanie plików dziennika kompilacji

Użyj poniższych procedur, aby wygenerować i wyświetlić pliki dziennika kompilacji dla danego scenariusza.

• Projekt C++:

  Program Visual Studio zapisuje pliki dziennika podczas tworzenia projektu. Typowe lokalizacje plików dziennika to Release\ProjectName>.log, Debug\<ProjectName.log i <ProjectName>>.txt.< Wszystkie lokalizacje plików są powiązane z folderem głównym projektu i na podstawie określonej konfiguracji.

  1. Użyj Eksploratora Windows lub Eksplorator plików, aby przejść do pliku dziennika.

  2. Otwórz plik dziennika w preferowanym edytorze.

• Projekt platformy .NET:

  W przypadku projektów .NET należy poinstruować program Visual Studio, aby zapisać pliki dziennika:

  1. W programie Visual Studio wybierz pozycję Kompiluj rozwiązanie kompilacji>.

  2. W oknie Dane wyjściowe wybierz tekst i użyj skrótu klawiaturowego Ctrl+S.

  Program Visual Studio wyświetli monit o zapisanie danych wyjściowych kompilacji. Następnie możesz otworzyć pliki dziennika z tej lokalizacji w programie Visual Studio lub innym edytorze.

• MSBuild:

  Dzienniki kompilacji można wygenerować, uruchamiając program MSBuild bezpośrednio z poziomu wiersza polecenia przy użyciu -fileLogger opcji wiersza polecenia (-fl). Aby uzyskać więcej informacji, zobacz Uzyskiwanie dzienników kompilacji za pomocą programu MSBuild.

  Za pomocą programu MSBuild można również wygenerować dzienniki binarne (-binaryLogger lub -bl opcję wiersza polecenia). Dzienniki binarne można wyświetlić w podglądzie dzienników strukturalnych. Przeglądarka dzienników strukturalnych udostępnia bogatszy interfejs użytkownika, który może ułatwić zrozumienie złożonych procesów kompilacji.

Zmienne środowiskowe można ustawić, aby skonfigurować program Visual Studio w celu zapisania dziennika binarnego w systemie plików. Ustaw MSBuildDebugEngine wartość i ustaw MSBUILDDEBUGPATH na żądaną lokalizację pliku dziennika kompilacji1. Zmienne muszą być ustawiane w środowisku, w którym jest uruchamiany program Visual Studio. Te ustawienia mają wpływ na wszystkie kompilacje programu Visual Studio, więc może nie być dobrą opcją, jeśli chcesz tylko dzienniki dla konkretnego wywołania kompilacji.

Aby uzyskać bardziej zaawansowaną obsługę interfejsu użytkownika na potrzeby rejestrowania kompilacji w projektach platformy .NET, rozważ zainstalowanie rozszerzenia Project System Tools. Po zainstalowaniu rozszerzenia można włączyć i wyłączyć logowanie binarne w interfejsie użytkownika, a następnie wybrać jedną z list dzienników. Jednak ze względu na sposób integracji z systemem kompilacji programu Visual Studio dzienniki są nieco inne niż te, które można uzyskać z okna Dane wyjściowe lub ze zmiennymi środowiskowymi.

Określanie szczegółowości danych dla dzienników kompilacji

Możesz określić, ile informacji należy uwzględnić w plikach dziennika kompilacji. Ilość danych w kolumnach pliku dziennika jest mierzona jako szczegółowość rejestratora. Liczba wierszy pliku dziennika reprezentuje zebrane komunikaty. Czasownik dziennika (wartości kolumn) ma wpływ na typy zarejestrowanych komunikatów (wartości wierszy). Cicha szczegółowość generuje minimalne rejestrowanie w danych wyjściowych kompilacji. Diagnostyka to najbardziej pełne ustawienie i generuje pliki dziennika ze wszystkimi możliwymi danymi.

W poniższej tabeli przedstawiono typy komunikatów zbieranych na podstawie szczegółowości rejestratora:

Typ komunikatu / Czasownik	Quiet	Minimalny	Normalna	Szczegółowe	Diagnostyka
Błędy	✅	✅	✅	✅	✅
Ostrzeżenia	✅	✅	✅	✅	✅
Komunikaty o wysokiej ważności		✅	✅	✅	✅
Komunikaty o normalnym znaczeniu			✅	✅	✅
Komunikaty o niskiej ważności				✅	✅
Inne informacje dotyczące aparatu MSBuild					✅

Można skonfigurować szczegółowość rejestratora, wykonując następujące czynności:

1. W programie Visual Studio wybierz pozycję Narzędzia>Opcje, aby otworzyć okno dialogowe Opcje.

2. W oknie dialogowym rozwiń sekcję Projekty i rozwiązania , a następnie wybierz kartę Kompilacja i uruchamianie .

3. Użyj listy rozwijanej szczegółowości danych wyjściowych kompilacji projektu MSBuild i wybierz preferencję danych wyjściowych kompilacji.

4. Użyj listy rozwijanej plik dziennika kompilacji projektu MSBuild i wybierz preferencję szczegółowości rejestratora.

   Napiwek

   Jeśli chcesz wyświetlić wiersze polecenia używane dla kompilatora i innych narzędzi, wybierz co najmniej poziom Szczegółowość .

5. Aby zastosować zmiany, wybierz przycisk OK.

Ważne

Należy ponownie skompilować projekt, aby zmiany zaczęły obowiązywać w oknie Dane wyjściowe . W przypadku projektów języka C++ ponowne kompilowanie projektu gwarantuje również, że zmiany zostaną odzwierciedlone w <pliku ProjectName>.txt .

Aby uzyskać więcej informacji, zobacz Opcje okno dialogowe, Projekty i rozwiązania, Kompilowanie i uruchamianie i LoggerVerbosity.

Używanie dzienników binarnych dla dużych plików dziennika

Dzienniki binarne to opcjonalna funkcja dla projektów platformy .NET, która umożliwia korzystanie z bogatszego środowiska przeglądania dzienników, które może ułatwić znajdowanie informacji w dużych dziennikach. Aby użyć dzienników binarnych, zainstaluj narzędzia Project System Tools 2022. Aby uzyskać więcej informacji, zobacz https://msbuildlog.com i Plik dziennika binarnego.

Powiązana zawartość

• Kompilowanie i czyszczenie projektów i rozwiązań w programie Visual Studio
• Kompilowanie i tworzenie kompilacji
• Uzyskiwanie dzienników kompilacji za pomocą programu MSBuild