SuperAPI AI 工具集

pythia-comment

通用与其它

查看项目

更新于 10-16 02:30

技能介绍

用途:在编写或修改 PL/SQL、以及将要交付到数据库的 .sql 文件时,约束注释写法。它作用于写入阶段,在 pythia apply 看到文件之前生效。

主要能力与规则:注释固定为一行,形状为“-- 11/09/2026 - jdoe - source flag reads the mapping table, not the join”,即日期 - 作者 - 变更内容,日期格式 DD/MM/YYYY,作者是开发者 handle,不能写智能体名称。仅覆盖 PL/SQL 和 SQL,即 pythia 所应用的范围。只允许 ASCII,因为 .sql 文件链路中仍有环节按 ANSI 读取,变音符号会在数据库长期保存的内容中变成乱码。

使用方式:开始时应声明“Using pythia-comment — one line, date - author - what changed.”。若需要第二行,说明注释容器选错了,应把内容移到别处:设计原因与破坏后果放 .sql 交付物的头部块;不可回退的规则放测试或校验器,作为带消息的断言;决策与被否决的替代方案放规格或工单;变更与原因放提交信息;语句本身已表达的内容不写注释。只注释代码无法展示的内容:陷阱、决策、原因。

禁止事项:单条语句上方的多行解释块;横幅、框线、-- ==== section ====;项目符号列表、引用的错误码、内联的修订考古;把注释掉的代码当文档保留;修改未变更代码上的注释。

完成前检查:统计新增注释行数,每条语句超过一行就是重写而非精简;确认注释确实到达数据库,可用 select count(*) from all_source where owner = :owner and name = :name and text like :marker 核对。预览中“changed outside pythia”警告是另一半检查,当对象自 pythia 上次写入后发生移动时会触发。

限制:资料未提供安装命令、收费、价格、平台与效果信息。