Understand for Mac 深度解析与操作指南

Understand 是一款由 SciTools 开发的静态代码分析工具，专为理解、维护和文档化大型、复杂的源代码库而设计。它支持超过二十种编程语言，通过构建详尽的代码数据库，提供强大的代码导航、度量分析、依赖可视化及架构探索功能，是软件工程师和架构师进行代码审查、重构和理解的得力助手。

一、核心界面与工作区详解

启动 Understand 后，主窗口被清晰地划分为多个功能区域，共同构成了高效的分析工作流。

• 菜单栏与工具栏 (Menu Bar & Toolbar)：位于窗口顶部，提供文件、编辑、视图、分析等所有高级命令的访问入口。工具栏可自定义，放置常用操作按钮。
• 项目浏览器 (Project Browser)：通常位于左侧。以树状结构展示项目中的所有文件、目录、类、函数、变量等实体。是导航代码结构的主要面板。
• 信息浏览器 (Information Browser)：通常位于右侧或底部。当在项目浏览器或代码编辑器中选中一个实体（如函数、类）时，此面板会动态显示该实体的详细信息，包括调用者、被调用者、继承关系、修改历史等。
• 代码编辑器 (Code Editor)：中央核心区域。提供语法高亮、代码折叠、点击跳转（按住 Command 键点击标识符）等功能的代码查看与编辑窗口。边缘常伴有代码度量指示条。
• 图形视图 (Graphical Views)：通过独立窗口或标签页展示。用于生成和控制流图、UML类图、依赖图等可视化图表。
• 度量结果面板 (Metrics Results)：通过“Metrics”菜单启动。以表格形式展示项目、文件、函数等不同级别的代码度量数据（如圈复杂度、代码行数、注释率等）。
• 状态栏 (Status Bar)：窗口底部，显示当前操作状态、分析进度等信息。

二、完整工作流程：从项目创建到结果导出

1. 创建或打开项目

步骤一：启动与新建 启动 Understand。在欢迎界面点击 “Create a New Project”，或通过菜单栏 File → New → Project… (Command+Shift+N)。

步骤二：配置项目 在弹出的对话框中：

1. 输入项目名称（Project Name）并选择保存位置。
2. 在“Language”选项卡下，勾选项目所涉及的所有编程语言。
3. 点击“Next”，选择添加源代码的方式。推荐选择“Add Directory…”以添加整个源代码根目录。
4. 浏览并选中源代码目录，点击“Choose”。
5. 确认文件列表后，点击“Create Project”。

步骤三：执行初始分析 项目创建后，Understand 会自动开始“分析（Analysis）”。您可以在状态栏查看进度。也可通过菜单 Project → Analyze All 手动触发完整分析。

提示：若要打开已有项目，使用 File → Open Project… (Command+O) 选择 .udb 项目数据库文件。

2. 探索与理解代码结构

步骤一：使用项目浏览器导航 在左侧“Project Browser”面板中，展开目录树。点击任何文件，会在中央编辑器打开。点击任何代码实体（如类名、函数名），编辑器会自动定位，右侧信息浏览器会更新相关信息。

步骤二：利用信息浏览器深入探查 在编辑器或项目浏览器中选中一个函数。观察右侧“Information Browser”，切换不同标签页：

• Calls：查看此函数调用了哪些函数（Outgoing），以及被哪些函数调用（Incoming）。
• Called By：专用于查看调用者。
• Contains：查看函数内部包含的语句、变量等。
• UML：生成该函数相关的UML序列图。

步骤三：代码编辑器内快速跳转 在编辑器阅读代码时，将鼠标悬停在任何标识符（变量、函数名）上，会显示其概要信息。按住 Command 键并单击该标识符，即可跳转到其定义处。使用工具栏的“后退/前进”箭头或快捷键 Command+[ / Command+] 在浏览历史中导航。

3. 进行代码度量与分析

步骤一：运行度量分析 通过菜单 Metrics → Run Metrics… 打开配置窗口。选择需要计算的度量指标集合（如“Code Count”，“Cyclomatic Complexity”）和应用的层级（Project, File, Function等），点击“Apply”。

步骤二：查看度量结果 分析完成后，会自动打开“Metrics Results”面板。以表格形式列出所有实体及其度量值。点击表头可按该列排序，快速找出高复杂度函数、大文件等。

步骤三：生成图表 在“Metrics Results”面板中，选中一行或多行，右键选择“Plot”，可以生成柱状图、折线图等可视化图表，直观对比度量数据。

4. 生成可视化图表

步骤一：创建依赖图 在项目浏览器中右键点击一个文件、目录或实体，选择 Graph → Graphical Views → Dependencies…。在弹出的配置窗口中调整显示选项，点击“OK”生成依赖关系图。

步骤二：创建UML类图 在项目浏览器中选中一个或多个类，右键选择 Graph → Graphical Views → UML Class Diagram…。可以生成显示继承、组合、关联关系的类图。

步骤三：交互操作图表 在生成的图形视图窗口中，可以拖动节点，使用鼠标滚轮缩放。点击图中的实体节点，同样可以跳转到代码定义处。

5. 导出结果与报告

步骤一：导出图表 在任何图形视图窗口中，通过菜单 File → Export As… 可将当前图表导出为 PNG、PDF、SVG 等格式的图像文件。

步骤二：生成文本报告 通过菜单 Reports → Generate Report… 打开报告向导。可以选择预定义的报告模板（如“函数列表”、“代码度量总结”），自定义内容后，导出为 HTML、纯文本或 LaTeX 格式。

步骤三：保存与关闭项目 所有工作完成后，项目数据会自动保存到 .udb 文件中。通过 File → Close Project 关闭当前项目。

三、常用功能进阶技巧

• 自定义视图与布局：所有面板（浏览器、编辑器）均可拖拽、停靠、浮动或关闭。可通过菜单 Window → Reset Layout 恢复默认布局。
• 强大的搜索功能：使用 Search → Find Entities… (Command+Shift+F) 进行精确的实体搜索，支持通配符和多种过滤器（按类型、语言等）。使用 Search → Find in Files… (Command+Shift+G) 进行全项目文本搜索。
• 代码比较 (Diff)：Tools → Diff Tool 可以比较两个文件、两个项目版本之间的差异，对于代码审查和变更分析非常有用。
• 自定义度量：高级用户可以通过 Metrics → Edit Metrics… 定义符合自己团队标准的自定义度量公式。
• 快捷键自定义：通过 Understand → Preferences → Key Bindings 可以为任何菜单命令分派或修改快捷键。

四、常见问题与解决方案

• 问题：分析后，某些函数或变量的引用关系不准确/缺失。
  
  解决方案：首先确认项目配置的语言是否正确。尝试执行更彻底的分析：Project → Re-Analyze All。对于大型项目，检查分析日志（Project → Analyze All 时勾选“Verbose”）看是否有解析错误。
• 问题：图形视图过于杂乱，节点太多。
  
  解决方案：在生成图形前，仔细配置过滤选项，例如限制依赖层级、排除系统库、只显示特定类型的实体。在图形生成后，使用视图窗口内的“Filters”按钮进行动态过滤。
• 问题：快捷键与Mac系统或其他应用冲突。
  
  解决方案：进入 Understand → Preferences → Key Bindings，搜索冲突的命令，将其快捷键修改或清除，并分配一个未被占用的新组合键。
• 问题：打开大型项目时软件响应缓慢。
  
  解决方案：关闭暂时不需要的浏览器面板（如信息浏览器）。在项目浏览器中使用过滤器减少显示项。考虑将项目拆分为多个更小的子项目进行分析。

五、Mac版快捷键汇总表