聯系電話:

021-68580866

如何在Perforce靜态代碼分析工具中生成(chéng)合規報告

創提信息
2022/05/09

分享到

确保和驗證您的代碼庫符合特定的編碼标準或行業規範可能(néng)是一個既困難又耗時(shí)的過(guò)程。然而，通過(guò)使用諸如Helix QAC和Klocwork之類的靜态代碼分析工具，您可以生成(chéng)一份合規報告，以查看您的代碼庫是否合規。


本文將(jiāng)包含如下幾個部分：
 
     • 爲什麼(me)合規報告很重要
 
     • 哪些合規報告是可用的
 
     • 如何在Helix QAC中生成(chéng)合規報告
 
     • 如何在Klocwork中生成(chéng)合規報告


爲什麼(me)合規報告很重要
 
合規報告使您能(néng)夠快速查看和報告項目進(jìn)度，助您了解特定編碼标準或行業規範的合規性，并确認剩餘的差距。Perforce靜态代碼分析工具Helix QAC和Klocwork可以幫助您生成(chéng)必要的報告，并優先考慮剩餘的合規問題。
 
而且，合規報告提供了一個完美的打印版或電子報告，可以與管理層、終端客戶、審計員、認證機構共享，作爲合規的證據。


哪些合規報告是可用的
 
Helix QAC和Klocwork都(dōu)有特定的合規報告可供生成(chéng)。
 
可用的合規報告：
 
    • 标準合規報告
 
    • MISRA合規報告——這(zhè)提供了MISRA 2020合規所需的全部數據
 
可以爲任何受支持的編碼标準和自定義标準生成(chéng)報告


如何在Perforce靜态代碼分析工具中生成(chéng)合規報告-1.png


如何生成(chéng)合規報告
 
在這(zhè)裡(lǐ)，我們會(huì)闡釋生成(chéng)合規報告的每一步流程。使用Helix QAC和Klocwork的流程略有不同。


如何使用Helix QAC生成(chéng)合規報告
 
要使用Helix QAC GUI生成(chéng)合規報告，請遵循以下逐步說(shuō)明。
 
    1. 選擇您想要爲其生成(chéng)合規報告的項目。
 
    (之前應該已經(jīng)使用rcf對(duì)項目進(jìn)行了必要的編碼标準分析)
 
    2. 從報告選項卡中，點擊 “爲項目生成(chéng)報告：”。
 
    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. 點擊 “确認” 生成(chéng)所選擇的報告。
 
報告還(hái)可以在命令行上生成(chéng)。


如何在Klocwork中生成(chéng)合規報告
 
    1. 從靜态代碼分析中的報告選項卡中，點擊菜單底部的“合規報告”，將(jiāng)出現合規報告用戶界面(miàn)。
 
    從合規報告用戶界面(miàn)中，您將(jiāng)能(néng)夠在左側面(miàn)闆中訪問以前生成(chéng)的報告，而右側面(miàn)闆爲您提供了生成(chéng)新報告的控件。
 
    2. 選擇您想要運行報告的分類。例如，C和C++。
 
    3. 在“構建”下，選擇要在報告中使用的構建方式。
 
    4. 在“視圖”下，選擇在報告中使用的視圖方式。注意：如果您將(jiāng)此字段保留爲空，則報告將(jiāng)使用默認視圖。
 
    5. 在“報告格式”下，您可以選擇MISRA選項，以生成(chéng)MISRA 2020指南格式的報告。默認情況下，報告使用Klocwork通用合規格式。
 
    6. 在“輸出文件類型”下，選擇報告的輸出類型。注意：默認是PDF。
 
    7. 在“輸出文件名稱”下，選擇報告的名稱。注意：默認的文件名是“project_name  specified build”。
 
    8. 在“輸出文件夾名稱”下，選擇保存報告的位置。注意：默認是左側工具條中合規報告的根文件夾。
 
    9. 選擇“僅摘要”，隻顯示報告中違規情況的摘要。注意：摘要和詳細的違規/偏離表都(dōu)默認包含在報告中。
 
    如果您想要查看完整的、非摘要版本的報告，您必須擁有合規許可。有關合規許可的更多信息，請聯系我們的客戶支持。
 
    10. 單擊“生成(chéng)”以創建報告。生成(chéng)的報告將(jiāng)出現在左側的報告面(miàn)闆中。注意：要删除以前生成(chéng)的報告，請將(jiāng)其從“projects_root/projects/custom_reports”文件夾删除。
 
在生成(chéng)報告之前，您可以采取的一個可選步驟是爲報告設置缺陷限制。然而，應該注意的是，随著(zhe)缺陷數量的增加，生成(chéng)時(shí)間將(jiāng)會(huì)減慢，并且報告的大小也會(huì)增加。此外，添加缺陷限制隻會(huì)影響完整的非摘要報告，因爲它對(duì)違規和偏離詳情表中問題的數量施加了限制。
 
這(zhè)還(hái)可以通過(guò)Web API運行。


開(kāi)始使用合規報告
 
通過(guò)使用報告獲取标準合規性相關的詳細信息。今天開(kāi)始免費試用Perforce靜态代碼分析工具吧。