aider--watch-files实战指南在 IDE 中直接编写 AI 注释来驱动编码与提问【免费下载链接】aideraider is AI pair programming in your terminal项目地址: https://gitcode.com/GitHub_Trending/ai/aider导读aider 是一款运行在终端里的 AI 结对编程工具而--watch-files模式让你不必离开自己熟悉的 IDE 或编辑器只需在任意代码文件的注释里写下以AI、AI!或AI?开头/结尾的单行指令并保存aider 就会自动感知文件变化、收集这些AI 注释把修改请求或疑问直接交给大模型执行。本文将完整拆解 AI 注释的语法规则、六种典型用法、极简写法并结合 watch.py 的源码与 test_watch.py 测试用例讲透其背后的识别正则、触发机制与提示词组装原理读完即可在 VSCode 等编辑器中流畅落地这套工作流。什么是 AI 注释把 IDE 变成 aider 的输入面板aider 的常规交互方式是终端里的聊天框。而--watch-files模式则换了一种更贴合在你正在编辑的代码旁边下指令的协作方式aider 会持续监听仓库中的所有文件只要检测到你在文件中写下的 AI 指令注释就会自动拾取并执行。启动方式很简单在终端运行aider --watch-files从源码看--watch-files定义在 args.py是一个布尔开关BooleanOptionalAction默认关闭因此也可以用--no-watch-files显式关闭。它的配置入口共有三处便于不同使用习惯配置途径写法依据命令行参数aider --watch-filesargs.py环境变量AIDER_WATCH_FILEStrue默认falsesample.env、options.md配置文件watch-files: true.aider.conf.ymlaider_conf.md、sample.aider.conf.ymlaider 究竟在找什么样的注释aider 会扫描仓库中所有文件查找以#、//或--开头的单行注释并从中挑出那些以AI、AI!或AI?开头或结尾的行。例如 Python 风格# Make a snake game. AI! # What is the purpose of this method AI?//注释语言同理// Write a protein folding prediction engine. AI!两类特殊标记对应两种不同的动作AI!带感叹号触发 aider 对代码执行修改AI?带问号触发 aider 回答你的问题。普通的不带!/?的AI注释只是被记录在案不会被立即执行——你可以攒够一批后用一条AI!统一触发。源码视角AI 注释到底是怎么被认出来的识别逻辑的核心在 watch.py 中FileWatcher类编译好的这条正则ai_comment_pattern re.compile( r(?:#|//|--|;) *(ai\b.*|ai\b.*|.*\bai[?!]?) *$, re.IGNORECASE )几点值得注意的实现细节该正则对大小写不敏感re.IGNORECASE所以文档示例中才会出现小写ai的合法写法前缀注释符覆盖#、//、--还额外支持了;分号这是为 Lisp 家族注释风格预留的get_ai_comments中注释 Added semicolon for Lisp comments见 watch.pyget_ai_comments()在 watch.py 中逐行扫描返回三个结果注释所在行号、注释原文、动作标记None/!/?。判断动作时对注释去注释符、去空格后检查是否以ai!/ai?开头或结尾。这些边界情况都有专门的测试夹具覆盖test_watch.py 分别验证了 Python 夹具 tests/fixtures/watch.py、JavaScript 夹具 tests/fixtures/watch.js内含 16 处 AI 注释、提问夹具tests/fixtures/watch_question.js动作标记为?以及 Lisp 夹具tests/fixtures/watch.lisp。端到端示例让 aider 替你实现一个函数在代码里写下这样一行注释并保存function factorial(n) // Implement this. AI!aider 检测到以AI!结尾的注释后会把文件加入会话并让模型就地实现于是文件被更新为function factorial(n) { if (n 0 || n 1) { return 1; } else { return n * factorial(n - 1); } }请求完成后aider 还会顺手把这段 AI 注释从代码中移除详见下文幕后原理。支持的注释风格与文件过滤规则原文档明确aider 只监听这些类型的单行注释# Python and bash style // Javascript style -- SQL style它会在所有文件中查找这些注释形态因此即使注释符与当前文件语言不匹配也没关系——例如在 Python 文件里写// ... AI!同样能被识别并触发因为它们只是充当 aider 的指令载体。在监控层面watch.py 还内置了几道闸门避免无关文件打扰gitignore 过滤load_gitignores()watch.py会把仓库.gitignore、.aiderignore与一长串内置默认忽略项如.git、.env、node_modules/、.venv/、.idea/、.vscode/、*.log、*.svg、*.pdf、编辑器备份文件*~、*.swp、*.pyc等合并成一份PathSpec命中即跳过见 watch.py文件大小上限超过 1MB 的文件不读取内容、不参与匹配watch.py路径范围只监控仓库根目录root内的文件配合--subtree-only时可收窄到当前子目录见 main.py。AI 注释的四种高效玩法这套机制非常灵活文档中展示了多种典型用法。1. 就地in-context指令把请求写在要改的那个函数里让上下文近在咫尺app.get(/sqrt/:n, (req, res) { const n parseFloat(req.params.n); // Add error handling for NaN and less than zero. AI! const result math.sqrt(n); res.json({ result: result }); });2. 多条注释 最终统一触发可以先写多条不带!的AI注释最后再用一条AI!触发。这些注释还可以分散在多个文件里用于协调跨文件的联动修改但记得把AI!放在最后app.route(/factorial/int:n) def factorial(n): if n 0: return jsonify(errorFactorial is not defined for negative numbers), 400 # AI: Refactor this code... result 1 for i in range(1, n 1): result * i # ... into to a compute_factorial() function. AI! return jsonify(resultresult)3. 长文本指令块需要较长说明时可以用一整块注释写清楚只要保证其中至少有一行以AI或AI!开头/结尾就能引起 aider 的注意# Make these changes: AI! # - Add a proper main() function # - Use Click to process cmd line args # - Accept --host and --port args # - Print a welcome message that includes the listening url if __name__ __main__: app.run(debugTrue)4. 用一条注释把文件加入会话在终端聊天里通常用/add添加文件。而在--watch-files模式下只需在文件中放一个#AI注释并保存文件就会被自动加入 aider 会话。此时即使你立刻撤销/删除这条注释文件也仍然留在会话中。这一点可以从源码中得到印证process_changes()watch.py会把变更文件加入coder.abs_fnames集合并打印Added file to the chat如果文件里只有普通AI注释、没有任何!/?触发标记则只做添加文件动作并提示End your comment with AI! to request changes or AI? to ask questions与终端聊天无缝衔接先用注释启动再进终端深化用 AI 注释把改动开个头往往很高效但后续想继续打磨时切回终端聊天同样方便——因为aider 聊天上下文里保留了刚才这批 AI 注释的记录你可以顺着它们自然延续。终端聊天还提供了大量 AI 注释之外的进阶能力用/undo回退不满意的改动在 IDE 里也可用编辑器自身的撤销来逐步回溯文件历史使用聊天模式提问或求助用/tokens、/clear、/drop、/reset管理聊天上下文——AI 注释会把文件加入会话累积过多时记得用这些命令清理不再需要的上下文修复 lint 与测试错误运行 Shell 命令等等。偷懒指南极简ai!注释也完全够用上面所有示例都用了完整句子与规范大小写那是为了便于讲解。实际上大多数 LLM 完全能处理歧义并推断隐含意图因此你可以写得非常随意既可以用小写ai/ai!也可以把请求本身压到最简。当上下文足以表明意图时一句ai!或许就够了。例如在一个充满数学函数的程序里实现阶乘函数下面任一种写法通常都能生效function factorial(n) // ai!或者// add factorial() ai!与其写冗长的 Add error handling for NaN and less than zero让 aider 自己推断需求即可这样简单的一句往往就够app.get(/sqrt/:n, (req, res) { const n parseFloat(req.params.n); // add error handling ai! const result math.sqrt(n); res.json({ result: result }); });同理前面的重构需求其实也可以浓缩成这样app.route(/factorial/int:n) def factorial(n): if n 0: return jsonify(errorFactorial is not defined for negative numbers), 400 # ai refactor... result 1 for i in range(1, n 1): result * i # ... to compute_factorial() ai! return jsonify(resultresult)至于到底需要写多明确随你与所选 LLM 的磨合自然形成手感。幕后原理AI 注释如何被喂给大模型aider 会把你收集到的 AI 注释连同 repo map仓库地图 以及会话中已加入的所有代码上下文一起发送给 LLM同时它会从代码中把 AI 注释抽取并高亮出来配以所在位置的代码上下文让模型精确理解注释与代码的镶嵌关系。构造给模型的指令模板定义在 watch_prompts.py修改类动作使用watch_code_prompt提问类动作使用watch_ask_prompt以/ask命令形式发起。修改类提示词的要点是告诉模型注释用█标记就藏在共享的代码文件中、包含了用户的指令请按要求修改并把代码里的所有 AI 注释一并删除The AI comments below marked with █ can be found in the code files Ive shared with you. They contain your instructions. Make the requested changes. Be sure to remove all these AI comments from the code! todo_app.py: ⋮... │class TodoList: ⋮... │ def __init__(self): │ Initialize an empty todo list ⋮... │ │ def list_tasks(self): │ Display all tasks █ # Implement this. AI! │ │def main(): │ todo TodoList() │ ⋮...这段上下文拼装由process_changes()完成它会遍历会话中已跟踪的所有文件重新提取 AI 注释再用grep_ast的TreeContext生成带█定位标记mark_loisTrue、add_lines_of_interest()的代码上下文注释行会按缩进树结构展示出来见 watch.py。一次完整的触发链路把上面的实现串起来一次AI!触发在仓库内走的是这条链路io.pyaider 进入等待输入时后台启动FileWatcher独立守护线程见 watch.py文件保存引发变化后io.py 检测到输入被中断interrupt_input随即调用process_changes()该函数先添加文件进会话再根据动作标记!/?选择watch_code_prompt或watch_ask_prompt模板模板 高亮注释上下文作为一条用户消息注入会话交给 LLM 执行修改或回答main.py 负责在启动时按--watch-files创建并绑定FileWatcher。这套特性最初源自对 IDE 文件监听思路的借鉴受 Override 项目监听文件变化、从代码内特定分隔符中提取内嵌提示方式的启发aider 将其简化为人人都能上手的AI/AI!/AI?约定。想进一步验证识别与过滤行为的读者可以阅读对应的单元测试 tests/basic/test_watch.py或直接查看各语言夹具 tests/fixtures/watch.py 与 tests/fixtures/watch.js 里的真实注释样例。【免费下载链接】aideraider is AI pair programming in your terminal项目地址: https://gitcode.com/GitHub_Trending/ai/aider创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考