用途:在源代码文件中添加 PUT 工作流注解,让 putior 抽取结构化工作流数据并生成 Mermaid 图。适用于分析代码库后按注解计划补充工作流文档、丰富自动检测结果,或记录数据管道、ETL 与多步计算流程。
主要能力:通过 get_comment_prefix() 按语言获取正确注释前缀,如 R/Python 用 #、SQL/Lua 用 --、JS/TS/Go/Rust 用 //、MATLAB 用 %。put_generate() 可基于自动检测的输入输出生成单行或多行注解骨架,支持输出到控制台或剪贴板。注解字段包括必填的 id、label,以及可选的 input、output、node_type;node_type 可取值 input、output、process、decision、start/end,控制 Mermaid 节点形状。.internal 后缀标记仅内存变量;跨文件数据流通过持久化文件名匹配连接。JS/TS 等 // 前缀语言还支持在 /* / 或 /* */ 块注释中用 * put 添加注解。
使用方式:先用 get_comment_prefix() 确认前缀,再运行 put_generate("./src/etl/") 等命令生成骨架,手工完善后插入文件顶部或相关代码块上方。校验时运行 put("./src/", validate = TRUE),并用 put_diagram() 查看图,put_merge() 可补充自动检测结果。exclude 参数可排除文件。
限制:Python 三引号字符串中的注解不被识别,须用 #;# 前缀语言与 -- 前缀语言不支持块注释注解;块注释注解不支持反斜杠续行;id 须在整个扫描目录内唯一;.internal 变量只能作为输出,不能作为跨文件输入;注解引号须用单引号;多行续行的反斜杠须位于行尾。