SuperAPI AI 工具集

self-commenting

编程与开发

查看项目

更新于 10-17 17:55

技能介绍

Self-Commenting 是一套用于在代码中建立长期记忆层的 AI 原生注释系统,通过可被 grep 搜索的 AICODE-* 标记,让后续会话能够找回此前的上下文、未完成的任务与已解决的问题。

用途 它面向与代码文件打交道的 AI 工作流,主要解决跨会话的记忆延续问题:在代码中留下结构化标记,使未来的自己或其他会话能够快速理解“为什么这样写”“还有什么没做”“某个坑是怎么填的”。

主要能力 系统定义了三类标记:

  • AICODE-NOTE:记录关键实现细节。
  • AICODE-TODO:记录待完成的任务。
  • AICODE-FIX:记录非平凡缺陷的解决方案,按“问题 → 原因 → 修复”的形式记录。

使用方式 采用 SCAN → WORK → ANNOTATE 三步流程:

  1. SCAN:在修改任何文件之前,先用 grep -rn "AICODE-" <file-or-directory> 查找已有标记,阅读这些标记以了解先前的上下文与待办事项。
  2. WORK:正常编辑代码。
  3. ANNOTATE:为跨会话记忆添加相应标记。

会话工作流建议:

  • 开始时执行 grep -rn "AICODE-" src/。
  • 调试前先检查代码库中是否存在类似的 AICODE-FIX。
  • 结束时为未完成的工作添加 TODO,为关键决策添加 NOTE,为已解决的缺陷添加 FIX。

判断规则 应添加 AICODE-NOTE 的情况:非显而易见的算法或方案、外部 API 约束、复杂状态管理、集成中的特殊之处。 应添加 AICODE-TODO 的情况:任务超出当前范围、需要更多信息、依赖其他工作。 应添加 AICODE-FIX 的情况:缺陷解决方案非平凡、根因不明显、类似缺陷可能在其他地方出现。 应跳过标记的情况:代码本身已足够自解释、使用标准模式、平凡的一行修复。

格式、语言语法与示例详见 references/conventions.md,具体内容暂未提供。

适用场景 适用于需要 AI 在多次会话之间保持代码上下文连贯的开发工作,尤其是涉及复杂实现、外部接口约束、跨模块集成和疑难缺陷排查的项目。

限制 相关资料仅描述了标记约定与工作流程,未提供具体的安装方式、支持的语言范围或工具集成细节,这些内容暂未提供。