共用方式為

檢視、儲存及設定組建記錄檔

  • 發行項

在 Visual Studio 互動式開發環境 (IDE) 組建專案後，您可以在 Visual Studio 的「輸出」 視窗檢視組建的記錄資訊。 輸出資料可以儲存到記錄檔，讓您在 Visual Studio 和其他編輯器中檢視。

記錄可協助您對組建的問題進行疑難排解。 您可以找出用於所有組建工具的確切命令行，並取得整個組建程序的完整診斷資料。 Visual Studio 提供選項來指定您想要在組建輸出和組建記錄檔中看到的資訊種類。

本文說明如何在 Visual Studio 產生、設定及檢視組建記錄檔。

產生和檢視組建記錄檔

使用下列程序來為您的案例產生及檢視組建記錄檔。

  • C++ 專案：

    Visual Studio 會在您建置專案時為您儲存記錄檔。 記錄檔的常見位置包括 Release\<ProjectName>.log、Debug\<ProjectName>.log 和 <ProjectName>.txt。 所有檔案位置都與您的專案根目錄資料夾相對，並以您的特定組態為依據。

    1. 請使用 Windows 檔案總管或檔案總管瀏覽至記錄檔。

    2. 在偏好的編輯器開啟記錄檔。

  • .NET 專案：

    如為 .NET 專案，您需要指示 Visual Studio 儲存記錄檔：

    1. 在 Visual Studio 中，選取 [組建]>[組建解決方案]。

    2. 在 [輸出] 視窗中，選取文字並使用 Ctrl+S 鍵盤捷徑。

    Visual Studio 會提示您輸入要儲存建置輸出的位置。 接著您就可以在 Visual Studio 或其他編輯器中，從該位置開啟記錄檔。

  • MSBuild：

    您可以透過直接從命令列執行 MSBuild (使用 -fileLogger (-fl) 命令列選項) 來產生組建記錄。 如需詳細資訊，請參閱使用 MSBuild 取得組建記錄檔。

    使用 MSBuild，您還可以生成二進位記錄 (-binaryLogger 或 -bl 命令列選項)。 您可以在結構化記錄檢視器中查看二進位記錄。 結構化記錄檢視器提供了更豐富的 UI，可讓您更輕鬆地了解複雜的建置過程。

您可以設定環境變數，將 Visual Studio 設定為將二進位記錄寫入檔案系統。 將 MSBuildDebugEngine 設為 1，並將 MSBUILDDEBUGPATH 設為想要放置建置記錄檔的位置。 這些變數必須在啟動 Visual Studio 的環境中設定。 這些設定會影響所有 Visual Studio 的建置，因此如果您只想要特定呼叫建置的記錄，這可能不是一個好選擇。

對於 .NET 專案中更進階的建置記錄 UI 支援，請考慮安裝 Project System Tools 擴充功能。 安裝擴充功能後，您可以在 UI 中啟用或停用二進位記錄，並從記錄清單中進行選擇。 然而，由於它與 Visual Studio 建置系統的整合方式，這些記錄與您從輸出視窗或使用環境變數取得的記錄會略有不同。

指定組建記錄的資料詳細資訊

您可以指定要納入組建記錄檔的資訊量。 記錄檔的資料量是以記錄器詳細資訊的形式來計算。 記錄檔資料列的數量代表收集的訊息。 記錄詳細程度 (欄值) 會影響所記錄的訊息類型 (列值)。 「無訊息」的詳細資訊會在組建輸出中產生最少的記錄。 「診斷」是最詳細的設定，產生的記錄檔會包含所有可能的資料。

下表所示為根據記錄器詳細資訊所收集的訊息類型：

訊息類型/ 詳細資訊 Quiet 最小 正常 詳細 Diagnostic
錯誤 ✅ ✅ ✅ ✅ ✅
警告 ✅ ✅ ✅ ✅ ✅
高重要性的訊息 ✅ ✅ ✅ ✅
一般重要性的訊息 ✅ ✅ ✅
低重要性的訊息 ✅ ✅
其他 MSBuild 引擎的資訊 ✅

您可以透過下列步驟來設定記錄器詳細資訊：

  1. 在 Visual Studio 中，選取 [工具]>[選項] 以打開 [選項] 對話方塊。

  2. 在對話方塊中，展開 [專案和解決方案] 區段，然後選取 [組建與執行] 索引標籤。

  3. 使用「MSBuild 專案組建輸出詳細資訊」下拉式清單，然後選取您的組建輸出偏好設定。

  4. 使用「MSBuild 專案組建記錄檔詳細資訊」下拉式清單，然後選取您的記錄器詳細資訊偏好設定。

    提示

    如果您想要查看編譯器和其他工具所使用的命令列，請選擇至少詳細詳細程度。

  5. 選取 [確定] 以套用變更。

重要

您必須重新組建專案，才能讓變更在「輸出」視窗中生效。 如為 C++專案，專案重新祖建也可確保讓變更反映在 <ProjectName>.txt 檔案中。

如需詳細資訊，請參閱選項對話方塊、專案和解決方案、建置並執行及 LoggerVerbosity。

針對大型記錄檔使用二進位記錄

二進位記錄檔是適用於 .NET 專案的選擇性功能，它可讓您擁有更豐富的記錄檔瀏覽體驗，以便您可以輕鬆地在大型記錄中尋找資訊。 若要使用二進位記錄檔，請安裝 Project System Tools。 如需詳細資訊，請參閱 https://msbuildlog.com 與二進位記錄檔。

二進位記錄檔是適用於 .NET 專案的選擇性功能，它可讓您擁有更豐富的記錄檔瀏覽體驗，以便您可以輕鬆地在大型記錄中尋找資訊。 若要使用二進位記錄檔，請安裝 Project System Tools 2022。 如需詳細資訊，請參閱 https://msbuildlog.com 與二進位記錄檔。

相關內容