QAC工具介绍和使用说明（供一种可量化措施的代码度量值属性：33基于功能 32基于文件和4个项目级别）

1、 QAC介绍和使用说明 其他的功能概括 1、提供一种可量化措施的代码度量值属性：33基于功能 32基于文件和4个项目级别 2、功能结构关系图，以提供控制流动洞察 3、展示全局调用函数的关系图引用和文件树结构 4、提供统计分析对代码质量的全面评估 5、跨模块分析能力（CMA）、分析递归功能和全局标识符的各种问题 6、简化的旧代码修改的设置基准模块 Source..c文件通过分析工具生成3种文件source.c.i、source.c.met、source.c.err。source.c.i文件可以直接生成报告文件，.met、.err这两个文件可以分析出功能结构、关系、特征标准、报告或者进行跨模块分析，对于跨模块分析和剖析器分析需要进行配置，source.c.met、source.c.err、配置文件可以在信息浏览器中显示 2、 规划 2.1、自动生成文件及参数说明 生成自动文档步骤： 1、从文件菜单中选者Auto-Create Project 2、进入Root Folder Name，这是工程的根目录，后面的自动生成的文件都会对应此根目录产生 3、进入Starting Directory，这个源代码目录与工程的根目录相连 4、进入Output File Path，这里可以选择QAC分析后的输出文件，好的情况就是用一个专门的目录和工程根目录相连 5、Replicate source tree structure in output paths通常是为输出部分建立一个子目录结构，这里可以有2种选择，可以选择Parallel to Source Structure为源代码建立一个平行的目录结构，或者选择Sub-path to each source location把规定的输出的子目录嵌入到源工程目录下面 6、选择File Extensions可以加入项目，通常只要选择一个.C文件，包括对.H文件也就被加入 7、为文件夹选择一个个性，可能会使用默认设置为起始点，可以在QAC中选择Configuration菜单 8、点击OK就是建立了工程，包含源文件工程和子文件夹 9、保存文件，外部扩展名为.prj 注意：也可以在已有的项目上自动生成一个文件夹，点击菜单Edit > Auto-create Sub-Folders，其余步骤和以上相同 文件夹参数：包括文件夹名称、默认源路径、输出路径和三种个性 可以进入Edit > Folder Parameters只可以改变文件夹参数，进入Edit > Propagate Changes to Sub-Folders可以改变所有子文件夹参数 2.2、手动生成文档及参数说明 生成手动文档步骤： 1、从菜单File中选择New Project，显示一个对话框New Project Parameters 2、进入Root Folder Name，输入一个项目名称 3、进入Default Source Path为项目初始化文件夹，这个路径可以改变所有子文件夹 4、在Output File Path中选择需要输出的分析文档 5、为工程选个个性 6、点击 OK创建项目，这工程的配置是唯一的文件夹 7、按要求增加更多的子文件夹和文件按要求 8、保存文件，外部扩展名为.prj 文件夹参数;在File > Reopen这项中可以有10多个选项，当没用的文件可以选择Clean-up。 文件和目录的位置时重新打开项目，将检查的存在。如果不存在一个条目将显示下面的对话框。有的更正可以自动应用的过程。 2.3、选择输出文件 一般文件夹的层次结构在在左边显示，选择的列表在文件的右边显示 所有的选择都在Browse 和d Reports这两个菜单中 A、如果选择单个文件或一组文件，则使用 B、否则当前所选文件夹，再加上所有子其文件夹，窗体所选内容。这意味着使用这些文件夹中的所有文件。 在浏览器内修改，有可能会改变开始的选择，用Select Files…在File菜单内 2.4、互相比较和环境变化的报告 2.4.1、根路径 2.4.2、基于GUI的环境变量创建 2.4.3、相对路径和环境变量的运用 选择Apply Relative Paths项可以选择相对路径减少的所有文件条目，根目录在右上角，表示保存项目文件的位置，确定路径是否合适相对路径减少。 选择Make file paths in each folder relative to its Default Source Path entry项，如果想要应用一个虚拟的环境变量表达默认每个文件的源路径到其他文件条目下。 在Available Environment Variables列表下，可以添加EVs to Apply至右边框中，将这种替换只发生在项目中的项的文件或关联的路径不受相对路径减少的个性 选择Apply path reduction to personality file entries associated with the project项，为了继续应用相对路径和环境变量在文件路径下的个性定义 选择Remove all path reduction from the project and associated personalities项若要撤消所有的相对路径和环境变量从相关个性设置项目恢复到完全在所有情况下限定的路径 例如，一个被重建的“Diff”项目如下所示与充分的relative道路实施 3、 配置QAC 为应用程序配置主要通过可访问Configuration > Options选项卡,有以下几点： Annotated Source 附加说明源 Cross-Module Analysis 跨模块分析 Custom Reports 自定义报告 Default Personalities 默认特性 Editor Preferences 编辑选项 Environment 环境 (Product)Extensions （产品）条目 Project File Options 项目文件选择 要查看您的安装与那些一起中的个性的一组在您的项目中定义，可以在Configuration下选择Message Personalities, Analyser Personalities or Compiler Personalities这几个选项 当创建了一个额外的特性，也可以设置它们成为系统默认，在Configuration>Options>Default Personalities下设置 3.1、配置编译器特性 看附录A 3.1.1、设置系统头文件 在系统包括系统标题选项卡上的标题，设置您系统标头包含路径 可以点击Suppress Output阻止这些头文件，当阻止了那些头文件，一些从特定的头文件或路径中产生的分析数据也不能在.err、.met文件中出现 您可以手动输入是相对于当前项目的路径位置，虽然建议进行完整路径选择和然后将任何选择的道路减少保存项目的过程中的应用操作 3.1.2、设置系统宏 在System Macro Defines下的Project Macros菜单中，设置宏同编译器或开发环境一致，宏可以在Compiler Personality或Analyser Personality设置 3.1.3、设置实现定义的类型 在c编译器里有3中类型定义，在“implementation defined”中选择，如下： size_t 一种无符号必需类型通过sizeof操作表示返回类型 ptrdiff_t 一种有有符号必需类型用减法运算的两个指针来表示 wchar_t 它反映了类型的范围内的整数类型字符文本和宽字符字符串 在Data Types下的Intrinsic Types条目控制这些类型的方法实施，需要以匹配编译器配置环境。所载入的任何相应类型声明头文件（e.g. stddef.h, stdio.h）必须反映内在匹配值类型。如果不符合，qac提示等级9的警告，如有必要，检查您的头文件确定适当的设置这些选项。 如上所述：QAC随提供一套标准库的头文件，如果想改变这些类型定义，必须先明白QAC内部的定义类型，因为那些头文件包含一些声明ptrdiff_t, size_t 和wchar_t，还有3种宏指令定义PRQA_PTRDIFF_T, PRQA_SIZE_T,和PRQA_WCHAR_T, 3.1.4、编译器扩展 许多编译器制造商实施 ISO C 的扩展语言定义来利用特定的硬件环境。特别是在嵌入式软件代码的速度和空间是重要 使用的语言扩展的危险是他们妥协可移植性。源代码越来越依赖于编译器和硬件环境。 QA C 是能够分析各种不同的语言变体和扩展，但它不是通常能够解释扩展在语义上。通常，必须配置该工具等，非标准关键字将被忽略。 有几种方法可以为此配置QAC，看附录B–extensions部分 《QAC工具详解及其使用指南》 QAC（Quality Assured C）是一款强大的静态代码分析工具，它提供了丰富的代码度量值属性，包括33种基于功能的度量，32种基于文件的度量以及4种项目级别的度量，为代码质量提供了可量化的评估依据。QAC不仅能够展示功能结构关系图，帮助理解代码的控制流，还能够通过全局调用函数关系图和文件树结构来揭示代码间的依赖关系。 QAC的统计分析功能能全面评估代码质量，包括跨模块分析（CMA），深入剖析递归功能和全局标识符可能导致的问题。分析过程中，QAC会生成source.c.i、source.c.met和source.c.err三个文件。其中，source.c.i用于生成报告，.met和.err文件则用于进一步的分析，如功能结构、关系、特性标准和跨模块分析。这些文件可通过信息浏览器查看，方便用户对代码进行深度理解与优化。 在使用QAC时，有自动化和手动两种方式创建项目。自动化创建项目，首先选择“Auto-Create Project”，设置根目录、源代码目录、输出文件路径，并选择文件扩展名，如.C文件。通过选择不同的配置，可以自动生成与源代码结构平行的输出目录。手动创建项目则需在“New Project”中输入项目名称，设定源代码路径和输出路径，然后根据需求添加文件和子文件夹。 在生成文档时，用户可以选择自动或手动方式。自动文档生成时，需要配置文件夹参数，如根目录、默认源路径、输出路径等；手动生成则需在“New Project Parameters”中设定各项参数。同时，QAC允许用户选择输出文件，可以是单个或一组文件，或者整个文件夹及其子文件夹。 QAC的配置选项丰富，包括注释源码、跨模块分析、自定义报告、默认特性、编辑器偏好、环境设置、扩展和项目文件选项等。在“Configuration > Options”中，用户可以调整编译器特性，如系统头文件路径、系统宏定义和实现定义的类型，确保与实际编译环境保持一致。此外，QAC支持处理编译器扩展，允许用户忽略非标准关键字，以增强代码的可移植性。 在进行环境变量和路径管理时，QAC提供了相对路径和环境变量的设置，以适应不同工作环境的需求。用户可以通过“Apply Relative Paths”和“Make file paths in each folder relative to its Default Source Path entry”等选项，灵活地管理和优化项目文件路径。 QAC工具以其全面的代码度量、强大的分析功能和灵活的配置选项，为开发者提供了高效且深入的代码质量检查手段，是提升软件质量和维护性的得力助手。正确理解和使用QAC，能够帮助开发团队在早期阶段发现并修复潜在问题，从而提高代码的可靠性和可维护性。