檢視、儲存及設定組建記錄檔
在 Visual Studio 互動式開發環境 (IDE) 中建置項目之後,您可以在 Visual Studio Output 視窗中檢視組建的記錄資訊。 輸出數據可以儲存至您可以在 Visual Studio 和其他編輯器中檢視的記錄檔。
記錄可協助您針對組建中的問題進行疑難解答。 您可以找出用於所有建置工具的確切命令行,並取得整個建置程式的完整診斷數據。 Visual Studio 提供選項來指定您想要在組建輸出和建置記錄檔中看到的資訊種類。
本文說明如何在Visual Studio中產生、設定及檢視組建記錄檔。
產生和檢視組建記錄檔
使用下列程式來產生及檢視案例的組建記錄檔。
C++專案:
Visual Studio 會在建置專案時為您儲存記錄檔。 記錄檔的常見位置包括 Release\<ProjectName>.log、Debug\<ProjectName>.log,以及 <ProjectName>.txt。 所有檔案位置都與您的專案根資料夾相對,並根據您的特定組態。
使用 Windows 檔案總管 或 檔案總管 流覽至記錄檔。
在慣用的編輯器中開啟記錄檔。
.NET 項目:
針對 .NET 專案,您會指示 Visual Studio 儲存記錄檔:
在 Visual Studio 中,選取 [建置>建置方案]。
在 [輸出] 視窗中,選取文字並使用 ctrl+S 鍵盤快捷方式。
Visual Studio 會提示您輸入儲存組建輸出的位置。 然後,您可以在 Visual Studio 或其他編輯器中,從該位置開啟記錄檔。
MSBuild:
您可以使用
-fileLogger
(-fl
) 命令行選項,直接從命令行執行 MSBuild 來產生建置記錄。 如需詳細資訊,請參閱 使用 MSBuild取得組建記錄。使用 MSBuild,您也可以產生二進位記錄(
-binaryLogger
或-bl
命令行選項)。 您可以在 結構化記錄查看器中檢視二進位記錄檔。 結構化記錄查看器提供更豐富的UI,可讓您更輕鬆地瞭解複雜的建置程式。
您可以設定環境變數,將 Visual Studio 設定為將二進位記錄檔寫入檔案系統。 將 MSBuildDebugEngine
設定為 1
,並將 MSBUILDDEBUGPATH
設定為建置記錄檔所需的位置。 必須在啟動 Visual Studio 的環境中設定變數。 這些設定會影響所有 Visual Studio 組建,因此,如果您只想要特定叫用組建的記錄,可能不是一個很好的選項。
如需在 .NET 專案中建置記錄的更進階 UI 支援,請考慮安裝 Project System Tools 擴充功能。 安裝擴充功能后,您可以在UI中開啟和關閉二進位記錄,然後選擇記錄清單。 不過,由於它與 Visual Studio 建置系統整合的方式,記錄與從 [輸出] 視窗或環境變數取得的記錄有點不同。
指定建置記錄的詳情程度
您可以指定要包含在組建記錄檔中的資訊量。 記錄檔中數據行的數據量以記錄器的詳略程度 來測量。 記錄檔數據列數目代表 收集的訊息。 記錄詳細級別(欄值)會影響記錄訊息的類型(列值)。 無訊息 詳細資訊會在建置輸出中產生最少的記錄。 診斷 是最詳盡的設定,並產生包含所有可能數據的紀錄檔案。
下表顯示根據記錄器詳細資訊收集的訊息類型:
訊息類型/ 冗長程度 | 安靜 | 極小 | 正常 | 詳細 | 診斷 |
---|---|---|---|---|---|
錯誤 | ✅ | ✅ | ✅ | ✅ | ✅ |
警告 | ✅ | ✅ | ✅ | ✅ | ✅ |
高重要性訊息 | ✅ | ✅ | ✅ | ✅ | |
一般重要性訊息 | ✅ | ✅ | ✅ | ||
低重要性訊息 | ✅ | ✅ | |||
其他 MSBuild 引擎資訊 | ✅ |
您可以使用下列步驟來設定記錄器詳細資訊:
在 Visual Studio 中,選取 [[工具]>[選項],以開啟 [選項] 對話框。
在對話方塊中,展開 [專案與解決方案] 區段,然後選取 [建置並執行] 標籤頁。
使用 MSBuild 專案建置輸出詳細資訊 下拉式清單,然後選取您的建置輸出偏好。
使用 MSBuild 專案建置記錄檔詳細資訊 下拉式清單,然後選擇您的記錄器詳細資訊設定偏好。
提示
如果您想要查看編譯程式和其他工具所使用的命令行,請選擇至少 詳細 詳細層級。
若要套用變更,請選擇 [確定]。
重要
您必須重建 專案,您的變更才會在 [輸出] 視窗 中生效。 對於C++專案,專案重建也會確保變更會反映在 <ProjectName>.txt 檔案中。
如需詳細資訊,請參閱 選項對話框、專案和方案、建置和執行 和 LoggerVerbosity。
針對大型記錄檔使用二進位記錄檔
二進位記錄是 .NET 專案的選擇性功能,可讓您擁有更豐富的記錄瀏覽體驗,可讓您更輕鬆地在大型記錄中尋找資訊。 若要使用二進位記錄,請安裝 Project System Tools。 如需詳細資訊,請參閱 https://msbuildlog.com
和 二進位記錄檔。
二進位記錄是 .NET 專案的選擇性功能,可讓您擁有更豐富的記錄瀏覽體驗,可讓您更輕鬆地在大型記錄中尋找資訊。 若要使用二進位記錄,請安裝 Project System Tools 2022。 如需詳細資訊,請參閱 https://msbuildlog.com
和 二進位記錄檔。