-
創提部落格
希望我們能與您分享和探討成長中的點點滴滴
如何在Perforce靜態程式碼分析工具中生成合規報告
創提科技
2022/05/09
分享到
確保和驗證您的程式碼庫符合特定的編碼標準或行業規範可能是一個既困難又耗時的過程。然而，通過使用諸如Helix QAC和Klocwork之類的靜態程式碼分析工具，您可以生成一份合規報告，以查看您的程式碼庫是否合規。
本文將包含如下幾個部分：
• 為什麼合規報告很重要
• 哪些合規報告是可用的
• 如何在Helix QAC中生成合規報告
• 如何在Klocwork中生成合規報告
為什麼合規報告很重要
合規報告使您能夠快速查看和報告專案進度，助您瞭解特定編碼標準或行業規範的合規性，並確認剩餘的差距。Perforce靜態程式碼分析工具Helix QAC和Klocwork可以幫助您生成必要的報告，並優先考慮剩餘的合規問題。
而且，合規報告提供了一個完美的列印版或電子報告，可以與管理層、終端客戶、審計員、認證機構共用，作為合規的證據。
哪些合規報告是可用的
Helix QAC和Klocwork都有特定的合規報告可供生成。
可用的合規報告：
• 標準合規報告
• MISRA合規報告——這提供了MISRA 2020合規所需的全部資料
可以為任何受支援的編碼標準和自訂標準生成報告
如何生成合規報告
在這裡，我們會闡釋生成合規報告的每一步流程。使用Helix QAC和Klocwork的流程略有不同。
如何使用Helix QAC生成合規報告
要使用Helix QAC GUI生成合規報告，請遵循以下逐步說明。
1. 選擇您想要為其生成合規報告的專案。
(之前應該已經使用rcf對專案進行了必要的編碼標準分析)
2. 從報告選項卡中，點擊 “為專案生成報告：”。
3. 選擇報告類型。關於合規性，選擇“標準合規報告”或“MISRA合規報告”
4. 可選：選擇輸出位置，默認為Helix QAC project folder \prqa\configs\config name\reports
5. 可選：選擇報告名稱，默認為project name_report name_datestamp_timestamp
6. 可選：選擇適用於MISRA合規報告(MCR)和標準合規報告(SCR)的參數
-L | --limit n - limit each non summary table to n rows
-S | --summary-only - only output the summary page, not the detailed output
7. 點擊 “確認” 生成所選擇的報告。
報告還可以在命令列上生成。
如何在Klocwork中生成合規報告
1. 從靜態程式碼分析中的報告選項卡中，點擊功能表底部的“合規報告”，將出現合規報告使用者介面。
從合規報告使用者介面中，您將能夠在左側面板中訪問以前生成的報告，而右側面板為您提供了生成新報告的控制項。
2. 選擇您想要運行報告的分類。例如，C和C++。
3. 在“構建”下，選擇要在報告中使用的構建方式。
4. 在“視圖”下，選擇在報告中使用的視圖方式。注意：如果您將此欄位保留為空，則報告將使用默認視圖。
5. 在“報告格式”下，您可以選擇MISRA選項，以生成MISRA 2020指南格式的報告。預設情況下，報告使用Klocwork通用合規格式。
6. 在“輸出檔案類型”下，選擇報告的輸出類型。注意：默認是PDF。
7. 在“輸出檔案名稱”下，選擇報告的名稱。注意：默認的檔案名是“project_name specified build”
8. 在“輸出資料夾名稱”下，選擇保存報告的位置。注意：默認是左側工具條中合規報告的根資料夾。
9. 選擇“僅摘要”，只顯示報告中違規情況的摘要。注意：摘要和詳細的違規/偏離表都默認包含在報告中。
如果您想要查看完整的、非摘要版本的報告，您必須擁有合規許可。有關合規許可的更多資訊，請聯繫我們的客戶支援。
10. 按一下“生成”以創建報告。生成的報告將出現在左側的報告面板中。注意：要刪除以前生成的報告，請將其從“projects_root/projects/custom_reports”資料夾刪除。
在生成報告之前，您可以採取的一個可選步驟是為報告設置缺陷限制。然而，應該注意的是，隨著缺陷數量的增加，生成時間將會減慢，並且報告的大小也會增加。此外，添加缺陷限制只會影響完整的非摘要報告，因為它對違規和偏離詳情表中問題的數量施加了限制。
這還可以通過Web API運行。
開始使用合規報告
通過使用報告獲取標準合規性相關的詳細資訊。今天開始免費試用Perforce靜態程式碼分析工具吧。