UE5 C++ Rider 编程指南 2： 如何使用Live Template编程实时模板？

0.什么是Live Template？

Live Template（实时模板）是IntelliJ IDEA等JetBrains系列IDE中提供的一种高效代码生成功能。它允许开发者通过预设的代码片段模板，快速插入常用代码结构，显著提升编码效率。以下是其核心特点的详细说明：

0.1. 模板类型

• 静态模板：固定不变的代码块（例如：main方法模板）
• 动态模板：包含可编辑变量（例如：for循环中的迭代变量）
• 文件模板：用于创建新文件时的基础结构（如：Class模板）

0.2. 典型应用场景

• 快速生成控制结构（if/for/while等）
• 创建常用注解（如@Override）
• 生成测试框架代码（JUnit的@Test）
• 插入日志语句（log.debug等）
• 构建常见设计模式代码

0.3. 高级特性

• 变量支持：${VAR}格式的可编辑占位符
• 表达式计算：使用Groovy脚本动态生成内容
• 上下文限定：指定模板只在特定语言/文件类型中生效
• 快捷键绑定：为常用模板设置专属快捷键

0.4. 使用示例

C++的if else模板：

if ($COND$)
{
  $SELECTION$
}
else
{
  $END$
}

（输入if后按Tab/Enter键即可生成，光标会自动定位到$COND$位置）

0.5. 模板管理

• 内置模板：IDE预置了各语言的常用模板
• 自定义模板：通过File→SSettings → Editor → Live Templates添加个性化模板
• 模板组：可创建分类管理不同用途的模板

Live Template不仅减少了重复输入的工作量，还能帮助团队保持一致的代码风格，是现代化IDE中不可或缺的生产力工具。

1. 手把手教学

这里带大家在Live Templates中添加一个region的个性化自定义模板，这个region在C#中有，但是C++却没有，所以习惯了使用region来管理代码结构分布的人必然希望可以复刻这个功能，实现步骤如下：

1. 通过File→Settings → Editor → Live Templates→ C/C++添加个性化模板，如下图所示：
   

2. 输入模板代码，如下：

#pragma region $NAME$
$END$
#pragma endregion

3. 配置模板行为，如图所示：
   

4. 在保存右侧的下拉菜单中选择This Computer全局选项，以后所有的项目都可以使用，使用方法很简单，直接输入region就会提示，如下图所示：
   

5. 生成的代码如下所示：

#pragma region OverrideFunctions
//在此区域内可以放置override的代码
#pragma endregion

2. C++代码中使用region管理代码结构的好处

在C++代码中使用#pragma region和#pragma endregion预处理器指令来管理代码结构的主要好处包括：

1. 代码可读性提升

   • 可以折叠大段代码为可读的标签块
   • 在IDE(如Rider)中显示为可折叠的树形结构
   • 示例：

     #pragma region Utility Functions
     	int calculateSum(int a, int b) { return a + b; }
     	double calculateAverage(double x, double y) { return (x + y)/2; }
     #pragma endregion
     

2. 逻辑分组清晰

   • 将相关功能代码组织在一起
   • 常见的分组方式：
     • 按功能(网络、UI、算法等)
     • 按访问权限(public、protected、private)
     • 按生命周期(初始化、主逻辑、清理)

3. 提升开发效率

   • 快速导航到特定代码区域
   • 一键折叠/展开所有region
   • 在大型项目中尤其有用(10万+代码行)

4. 维护性增强

   • 清晰标注模块边界
   • 方便后续重构和修改
   • 新开发者更容易理解代码结构

5. 非侵入式

   • 纯粹的预处理指令
   • 不影响实际编译结果
   • 只在支持该特性的IDE中生效

注意：

• 不是所有编译器都支持
• 过度使用可能导致反效果(每个函数都加region)
• 建议配合良好的命名规范使用

典型应用场景：

1. 类定义中的方法分组
2. 大型源文件中的功能模块划分
3. 测试代码与被测代码的隔离
4. 临时代码/实验性代码的标记