CLion教程-运行/调试配置
CLion使用运行/调试配置来运行、调试和测试您的代码。每个配置都是一组命名的启动属性,定义了要执行的内容,以及应该使用的参数和环境。
有两种类型的运行/调试配置:
- 临时配置 — 每次运行/调试测试、测试套件、夹具或
main()
入口时都会创建,使用了窗口标识 / 。 - 永久配置 — 显式从模板创建或通过保存临时配置创建的配置。永久配置将保留在您的项目中,直到将其删除。
因此,每当您运行/调试或测试代码时,CLion要么使用现有的永久运行/调试配置,要么创建一个新的临时配置。
永久配置具有不透明的图标,而临时配置的图标是半透明的。
临时配置的最大数量为5。当添加新配置时,旧配置将自动删除。如果需要,您可以在设置 | 高级设置 | 运行/调试 | 临时配置限制中增加此限制。
创建永久运行/调试配置
CLion提供了以下创建永久运行/调试配置的方式:
- 将临时运行/调试配置另存为永久配置。
- 从模板创建或复制现有配置。
将临时配置另存为永久配置
- 在运行/调试配置切换器中选择一个临时配置,单击 ,然后选择保存配置。
- 或者,在运行/调试配置对话框中选择一个临时配置,然后单击工具栏上的 。
CLion为不同的语言、工具和框架提供了运行/调试配置模板。可用模板的列表取决于已安装和启用的插件。
从模板创建运行/调试配置
- 转到运行 | 编辑配置。或者,按AltShiftF10,然后按0。
- 在运行/调试配置对话框中,单击工具栏上的 或按AltInsert。列表中显示运行/调试配置模板。
- 在“名称”字段中指定运行/调试配置的名称。此名称将显示在可用运行/调试配置的列表中。
- 如果要允许同时运行多个配置实例,请选择“允许多个实例”。如果禁用此选项,尝试重新运行配置将终止活动会话。
- 根据所选的模板,填写配置设置。例如,CMake应用程序、自定义构建应用程序、Gradle / Gradle本机应用程序。
- 在“启动前”部分,定义是否要在启动应用程序之前执行任何特定操作,例如,在运行前运行外部工具或其他构建配置。要跳过构建阶段,请从“启动前”列表中删除“构建”。
您可以立即运行配置,也可以保存配置以后再运行它。
- 单击“确定”以保存运行配置以供以后使用,并关闭对话框。
- 要立即运行配置,请单击“运行”。
共享运行/调试配置
如果您正在团队中工作,您可能希望共享您的运行/调试配置,以便您的队友可以使用相同的配置运行应用程序,或者允许他们远程附加到您正在运行的进程。
为此,CLion提供了一种通过VCS将运行/调试配置存储为项目文件并通过VCS共享它们的机制。当您想要将您的配置作为文件发送给其他人时,也可以使用相同的机制。这样可以节省大量时间,因为运行/调试配置有时会变得复杂,手动保持它们同步将是繁琐和容易出错的。
- 转到运行 | 编辑配置。或者,按AltShiftF10,然后按00。
选择要共享的运行/调试配置,启用“作为项目文件存储”选项,并指定配置文件的存储位置。
- 如果需要与CLion 2019.3及更早版本兼容,请将文件存储在默认位置。
- 如果需要与CLion 2019.3及更早版本兼容,请将文件存储在默认位置。
(可选) 如果将.idea目录添加到VCS的忽略文件中,则.idea/runConfigurations子目录也将被忽略。如果在Git中使用项目,您可以仅分享.idea/runConfigurations,并通过修改.gitignore如下来保持.idea被忽略:
/.idea/* !/.idea/runConfigurations
打开“作为项目文件存储”的选项不会自动提交任何内容到VCS。要使运行/调试配置进入共享存储库,您必须像其他已版本化的文件一样将它们检入。
运行/调试配置模板
所有运行/调试配置都基于模板,这些模板实现了启动逻辑,定义了参数列表和它们的默认值。可用模板的列表在安装时预定义,并且只能通过插件扩展。但是,您可以在每个模板中编辑默认参数值,以简化新运行/调试配置的设置。
更改模板的默认值不会影响已存在的运行/调试配置。
配置模板的默认值
- 转到运行 | 编辑配置。或者,按AltShiftF10,然后按0。
- 在运行/调试配置对话框的左侧窗格中,单击“编辑配置模板…”。
- 在打开的“运行/调试配置模板”对话框中,选择配置类型。
- 指定所需的默认参数,然后单击“确定”以保存模板。
您可以像常规运行/调试配置一样与团队成员共享运行/调试配置模板。
环境变量和程序参数
您可以通过将程序参数和环境变量添加到适当的运行/调试配置中来影响应用程序的运行时行为。
配置环境只会影响运行/调试进程,不会影响构建或其他阶段,如CMake生成。
- 转到运行 | 编辑配置。或者,按AltShiftF10,然后按0。
- 在打开的运行/调试配置对话框中,选择要传递参数和添加环境变量的配置。
- 在“程序参数”字段中键入参数。参数应该用空格或换行符分隔。
单击以展开文本字段,以便您可以将参数查看和编辑为列表。 在“环境变量”字段中,键入变量名和值:
<name>=<value>
。如果添加多个变量,它们应该用分号分隔。- 或者,单击并将变量名和值添加到用户环境变量列表中。
- 在打开的对话框中,您还可以查看可用系统环境变量的列表。如果不想使用系统环境变量来选定配置,请取消选中“系统环境变量”复选框。
- 您可以使用
$VAR$
语法引用现有变量,包括父环境变量。请注意,这样的引用区分大小写:例如,Linux/macOS的PATH=xxx:$PATH$
和Windows的Path=xxx;$Path$
。目前不支持引用现有变量用于远程工具链 (CPP-15693)。
- 或者,单击并将变量名和值添加到用户环境变量列表中。
使用“从文件加载变量”字段将CLion指向配置环境的脚本。此选项适用于CMake、Makefile、Gradle本机、自定义构建和测试配置(Boost.Test、Catch、Google Test、Doctest、CTest)。
- 在脚本中使用以下语法设置变量:
Windows
set VAR=value
Linux/macOS
export VAR=value
- 请注意,由脚本创建的环境仅适用于相应配置的单个启动,并且优先于自定义值。
- 指定的脚本将在“启动前”步骤之后运行。
运行/调试配置文件夹
当有多个相同类型的运行/调试配置时,您可以将它们分组到文件夹中,以便在视觉上更容易区分它们。
一旦分组,运行/调试配置将出现在相应文件夹下的列表中。
创建运行/调试配置文件夹
- 转到运行 | 编辑配置。或者,按AltShiftF10,然后按0。
- 在运行/调试配置对话框中,选择一个配置类型,并单击工具栏上的 。将为所选类型创建一个新的空文件夹。
- 在右侧的文本字段中指定文件夹名称,或接受默认名称。
- 选择所需的运行/调试配置,并将它们移动到目标文件夹下。
- 应用更改。如果文件夹为空,将不会保存它。
当您不再需要文件夹时,可以将其删除。分组在文件夹下的运行/调试配置将被移到相应的运行/调试配置类型的根目录下。