“QAC报告怎么生成“以及“QAC报告字段怎么按评审要求调整“,这两个问题一般不是单纯点哪里导出能说清的。真正到了项目评审的时候,评审人员看的并不是页面有多漂亮,而是报告里有没有把事情交代明白:扫描了哪些代码,用了什么规则,发现了哪些问题,哪些问题已经处理完了,哪些做了偏离或抑制,后面由谁负责。所以,生成报告之前,最好先把分析结果、规则配置和评审字段放在一起想清楚。
一、QAC报告怎么生成
1、先确认分析结果是否完整
生成报告前,需要先确认项目分析已经做完,分析结果也是有效的。
如果项目里还有很多文件没能分析成功,或者因为头文件、宏定义、编译器配置这些问题导致解析失败,这时候直接把报告导出来,评审时就很容易被问回来。
进入QAC项目后,要去检查源码文件是不是都分析过了,尤其要看有没有解析失败、依赖过期、头文件找不到这类基础问题。报告能做的只是把已有的分析结果整理出来,它可不会替人去修复分析环境,如果前面的分析就不完整,后面再怎么调整字段,也只能把一份不完整的结果导出来。
2、选择合适的报告类型
QAC里常见的报告类型有这么几种:CRR、HMR、MCR、MDR、SCR、SUR。CRR更偏向代码评审,能汇总代码文件、函数、类、度量还有消息;MCR主要面向MISRA合规;SCR侧重通用标准的符合性;SUR用来查看被屏蔽掉的诊断信息;MDR则会输出可以进一步去处理的度量数据。不同的报告适合不同的评审场景,不能对所有的项目都固定只导同一种报告。
3、通过界面生成报告
如果是通过图形界面来操作,一般先进入【Report】或者【Generate Report】这样的入口,把报告生成窗口打开以后,选好需要的报告类型,再去确认输出路径、报告名称,还有要不要打开报告目录。
在Visual Studio集成环境当中,报告也是按项目级别来生成的,选完报告类型后,系统会把输出放到设置好的Output Location里,生成之后还可以直接打开报告所在的位置。
二、QAC报告字段怎么按评审要求调整
QAC报告字段的调整,不能只理解成“把某几列显示出来”。评审的要求往往来自质量流程、功能安全流程、MISRA合规流程,或者客户的交付要求,所以调整字段之前,要先弄明白评审到底想确认什么。
1、先整理评审字段清单
评审时常用的字段一般包括这些:项目名称、软件版本、分析日期、QAC版本、规则配置文件、被分析文件的范围、文件路径、行号、消息编号、规则编号、严重等级、问题描述、处理状态、责任人、处理措施、偏离说明、抑制原因、关闭证据。这里面,有些字段QAC报告自己就能提供,另一些字段则需要团队在导出以后再去补充。
2、优先选择接近评审目标的报告
如果评审的重点是MISRA符合性,就优先去用MCR;如果评审的重点是标准规则的违反和抑制记录,就优先用SCR;如果评审想先看看代码质量和问题概貌,可以先看CRR;如果评审比较关心抑制项合不合理,那就单独去生成一份SUR。这样做,比先导出一份大而全的报告再手工去一列一列删字段,要稳当得多。
3、用参数控制报告输出范围
有一部分报告是可以通过参数来控制输出内容的,比方说MCR和SCR就支持只输出汇总页,也可以去限制非汇总表格的行数。在命令行方式下,可以在--后面加上这些自定义参数,像qacli report-P.-t MCR----summary-only,或者qacli report-P.-t SCR---L 100。这一类的做法比较适合用来生成评审摘要版,而不是把全部的明细一次性都塞进评审材料里。
三、评审版报告怎样整理更稳
QAC报告生成出来以后,不建议直接把原样就发给评审,尤其是正式项目,最好再整理出一版评审包,让评审人员能比较快地看到结论,也能方便地追溯到明细。
1、保留原始报告,不要直接改源文件
原始的HTML、XML或者工具导出的报告,应该单独保存,当作分析证据。评审用的Excel版或者汇总表,是可以在原始报告的基础上整理的,但是不要把原始数据改得完全走了样。后面如果客户或者质量人员要求复核,还能回到原始报告里去查。
2、补充人工处理字段
QAC可以告诉你规则、位置、问题说明和状态,但是“这个问题为什么可以接受”“由谁负责关闭”“偏离的依据是什么”“证据放在哪里”,这类信息通常要靠人工来补充。比较实用的做法,就是在表格里增加几列:处理结论、责任人、计划完成时间、偏离编号、关闭证据链接、评审备注。这样报告就能从“工具输出”变成一份“评审闭环材料”。
3、复杂字段用自定义报告处理
要是企业要求固定格式,比如必须输出特定的字段顺序、特定的表头、特定的统计口径,标准报告可能就不够用了。QAC是支持通过自定义报告插件来扩展报告生成方式的,通常可以用Python脚本去实现,把脚本放在安装目录下面的report_plugins目录里;自定义报告可以按需要去读取项目、违规、抑制、规则配置这些数据。
总结
总结来看,QAC报告怎么生成,关键还是先做完可靠的分析,再根据评审的目标去选择CRR、MCR、SCR、SUR这些合适的报告;QAC报告字段怎么按评审要求调整,关键则是先把评审要哪些字段明确下来,再用报告类型、输出参数、路径格式和人工补充字段去配合着处理。标准报告已经能应付大部分基础的交付需要,如果企业有固定的模板,还可以通过导出数据或者自定义报告插件去做更进一步的整理。