代码分析完成后,Understand可以将指标、交叉引用等结果整理成报告。导出前要先确定需要哪一种:批量报告适合保存项目资料,交互式报告适合查看某一类分析结果,指标数据则可以单独导出为CSV。选择好报告类型,再处理格式和保存位置,操作会更清楚。
一、Understand怎么导出代码分析报告
批量报告和交互式报告的导出入口不同。前者先配置内容再生成文件;后者打开报告窗口后保存。
1、生成项目批量报告
①依次点击【Reports】→【Configure Reports】,勾选需要的报告类型。
②选择HTML或文本格式,设置报告保存目录。
③依次点击【Reports】→【Generate Reports】,等待生成完成。
④依次点击【Reports】→【View Reports】→【HTML】,查看生成结果。
2、导出交互式报告
①需要查看整个项目时,依次点击【Project】→【Interactive Reports】,选择所需报告。
②需要查看单个文件或类时,右键点击目标对象,选择【Interactive Reports】中的报告。
③在报告窗口点击【Save】,选择【Export PDF】、【Export HTML】或【Export Text】,设置保存位置。
3、单独导出指标数据
①依次点击【Metrics】→【Browse Metrics】,查看需要导出的指标。
②依次点击【Metrics】→【Export Metrics】,在导出窗口选择指标。
③在【Save output to】中设置CSV文件位置,确认导出。
二、Understand分析报告导出失败如何排查
先分清失败发生在哪一步:菜单中找不到报告、报告打不开,还是打开后无法保存文件。对应检查报告插件、分析状态、格式、保存目录和授权状态,比反复点击导出更容易定位问题。
1、报告菜单中没有目标选项
①依次点击【Tools】→【Plugin Manager】,查找所需的交互式报告并启用。
②返回项目,重新打开【Project】→【Interactive Reports】。
③如果是针对文件或类的报告,右键点击对应对象,再查看【Interactive Reports】菜单。
2、报告内容为空或缺少数据
①确认项目中的目标源文件已加入分析范围。
②依次点击【Project】→【Analyze All Files】,等待分析结束。
③重新打开报告,核对所选对象和报告内容。
3、所需格式无法选择
①在交互式报告窗口点击【Save】,查看可用的HTML、PDF和文本格式。
②如需导出指标CSV,改用【Metrics】→【Export Metrics】。
③如需批量报告,返回【Reports】→【Configure Reports】,检查已选择的输出格式。
交互式报告窗口提供HTML、PDF和文本导出;CSV并非该窗口的保存选项。
4、文件无法写入保存目录
①在导出窗口中将目标位置改为本机可写的目录。
②检查同名报告文件是否正被其他程序打开,必要时更换文件名。
③重新导出,并在目标目录中确认文件是否生成。
5、出现授权相关提示
①依次点击【Help】→【Licensing】,查看当前授权状态。
②确认当前授权包含所需的导出权限,再重新执行导出。
三、导出后怎么检查报告是否完整
导出窗口关闭不等于报告已经可以使用。尤其是HTML批量报告,交付或归档前最好打开一次,检查内容与源项目是否对应。
1、核对报告内容
①打开导出的PDF或文本文件,检查标题、分析对象和主要数据。
②导出HTML批量报告时,进入输出目录并打开【index.html】。
③点击目录中的报告条目,检查页面能否正常打开。
2、区分不同分析批次
①每次重新分析后,为导出的报告设置带日期或版本号的文件名。
②将报告与对应的项目版本存放在同一归档目录。
③需要比较变化时,分别打开两个批次的报告核对数据。
总结
一份可用的代码分析报告,关键在于读者能看出它分析了哪个项目、哪一次代码版本,以及数据能否正常打开。导出后花一点时间核对这些信息,后续查阅和比较都会省事。希望本文能帮大家顺利完成Understand报告导出;如有Understand相关需求,欢迎联系我们咨询。