C4-PlantUML 新增 UpdateLegendTitle 函数自定义图例标题

在软件架构可视化工具 C4-PlantUML 的最新更新中，开发团队引入了一个实用的新功能——UpdateLegendTitle(newTitle) 函数，专门用于自定义图例的标题文本。

功能背景

C4-PlantUML 作为 PlantUML 的标准库扩展，提供了强大的软件架构图绘制能力。图例(legend)是架构图中重要的组成部分，它帮助读者理解图中各种元素的含义。在之前的版本中，虽然可以通过 Update...() 系列函数修改图例中的其他标签文本，但图例标题本身却无法直接自定义。

新增功能详解

新加入的 UpdateLegendTitle(newTitle) 函数解决了这一限制，允许开发者自由设置图例的标题文本。这个函数的使用非常简单：

@startuml
!include C4_Context.puml

UpdateLegendTitle("自定义图例标题") 
SHOW_LEGEND()

...其他图表内容...
@enduml

执行上述代码后，生成的图表将显示开发者指定的图例标题，而不是默认的"Legend"。

技术实现原理

在底层实现上，这个函数通过修改全局变量来存储用户指定的标题文本。当调用 SHOW_LEGEND() 函数时，系统会检查这个变量是否存在自定义值，如果存在则使用自定义标题，否则回退到默认值。

这种实现方式保持了 C4-PlantUML 一贯的简洁风格，同时提供了足够的灵活性。开发者可以在图表生成的任何阶段调用这个函数，甚至在多个位置调用以动态改变标题。

应用场景

这个功能在以下场景特别有用：

1. 多语言支持：当需要为非英语用户生成图表时，可以将图例标题本地化
2. 企业规范：遵循公司内部的图表规范，使用特定的标题格式
3. 教学材料：在教程或文档中，使用更描述性的标题来解释图表内容
4. 多图表一致性：确保一组相关图表使用统一的图例标题风格

最佳实践

为了获得最佳效果，建议：

• 在包含图表定义文件后立即设置标题
• 保持标题简洁明了
• 在同一组相关图表中使用一致的标题风格
• 考虑在团队内部建立标题命名规范

这个看似简单的功能增强，实际上提高了 C4-PlantUML 在复杂项目中的适用性，使得生成的架构图能够更好地满足不同场景下的文档需求。