嵌入UML活动图遇语法错误：Doxygen+PlantUML代码内联文档求助

错误原因分析 #

• 你把PlantUML的标记@startuml和@enduml拆到了多个Doxygen注释块里，Doxygen无法识别为完整的UML代码段
• PlantUML活动图语法不完整：只有start没有对应的end，也缺少描述加法逻辑的节点
• 未确保Doxygen配置里开启了PlantUML支持

修正后的代码示例 #

要把PlantUML代码放在同一个Doxygen注释块中，并且补全活动图语法：

/**
 * @brief 两数相加的函数
 * @param a 第一个加数
 * @param b 第二个加数
 * @return 两数之和
 * 
 * @startuml
 * start
 * :接收参数a和b;
 * :计算a + b;
 * :返回计算结果;
 * end
 * @enduml
 */
int add_numbers(int a, int b) {
    return a + b;
}

Doxygen配置要点 #

要让内嵌图生效，需要在Doxyfile里添加以下配置：

# 开启PlantUML支持
PLANTUML_JAR_PATH = /path/to/plantuml.jar
PLANTUML_INCLUDE_PATH = ./
# 允许在注释中嵌入PlantUML
ENABLE_PLANTUML = YES
# 设置生成的图内嵌到文档中（而非单独板块）
PLANTUML_OUTPUT_FORMAT = svg  # 或png，根据需求选择

实现内嵌文档的关键 #

• 所有PlantUML代码必须包裹在同一个/** */注释块内，且@startuml和@enduml要和其他Doxygen标签（比如@brief、@param）放在一起，不能拆分到函数体的注释里
• 确保活动图语法符合PlantUML规范，完整的流程节点（start、步骤、end）缺一不可
• 配置Doxygen时指定正确的PlantUML路径，这样生成文档时会自动渲染UML图并内嵌到函数的说明文档中

内容的提问来源于stack exchange，提问作者salem