如何在静态代码分析工具中生成合规报告

确保和验证您的代码库符合特定的编码标准或行业规范可能是一个既困难又耗时的过程。然而，通过使用诸如  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运行。

开始使用合规报告

通过使用报告获取标准合规性相关的详细信息。今天开始免费试用静态代码分析工具吧。

 “原创内容，转载请标明出处”