Repomix 注释移除--remove-comments完全指南降低 Token 占用、减少噪音并保留源码行为【免费下载链接】repomix Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomixRepomix 内置的注释移除功能可以在生成打包输出时自动剔除代码中的注释从而显著减少喂给 Claude、ChatGPT、DeepSeek 等 LLM 的 Token 数量让输出更精炼、更聚焦于真实代码。本指南基于 comment-removal.md 的官方说明结合 src/core/file/fileManipulate.ts、src/config/configSchema.ts 等仓库源码从命令行用法、配置文件、支持的语言类型、底层实现原理到处理流水线顺序为你提供一份可直接落地实践的完整参考。注释移除能做什么当把整个仓库打包成单文件交给大模型时注释往往占据了可观的 Token 开销。Repomix 的removeComments能力会在输出阶段按文件扩展名匹配对应的语言处理器删除单行注释、多行注释、文档注释、HTML/XML 注释以及 Python docstring 等各类注释同时保持源码文件本身不受影响——它只改变生成产物不会修改你的原始代码。该功能与另一项 Token 优化手段代码压缩code compression互补压缩通过 tree-sitter 抽取代码结构进一步精简内容注释移除则在压缩之前先剔除注释二者可以叠加使用相关内容可参考 code-compress.md。命令行用法--remove-comments在 CLI 中启用注释移除只需一个标志repomix --remove-comments该标志在 src/cli/cliRun.ts 中注册官方描述为 Strip all code comments before packing并提供了两个等价的别名同一文件第 40-41 行repomix --strip-comments # 等价别名 repomix --no-comments # 等价别名它还可以与其他选项自由组合例如指定输出格式与输出文件repomix --remove-comments --style markdown --output-file output.md从 CLI 解析到配置生效的完整链路是cliRun.ts解析--remove-comments→ src/cli/actions/defaultAction.ts 第 306-311 行检测到options.removeComments后写入cliConfig.output.removeComments→ 最终合并进运行时配置。若在命令行显式传入该值会覆盖配置文件中的同名设置。配置文件用法output.removeComments与部分旧版文档写法不同当前仓库的配置 Schemasrc/config/configSchema.ts 第 77 行将该项定义在output节点下而不是processing节点下{ output: { removeComments: true } }Schema 中该字段的默认值在 src/config/configSchema.ts 第 137 行明确为false即默认不删除注释属于显式开启型选项。完整的默认配置repomix.config.json还包含removeEmptyLines默认false等相邻选项建议配合使用以获得干净输出。支持移除的注释类型与语言Repomix 的注释移除基于扩展名分发到对应语言处理器覆盖范围很广。从 src/core/file/fileManipulate.ts 第 58-107 行的映射表可以确认以下扩展名与语言扩展名语言主要注释语法.c.h.cpp.hpp.cc.cxx.csC / C / C#//、/* */.js.jsx.mjs.cjs.mjsx.ts.tsx.mts.cts.mtsxJavaScript / TypeScript//、/* */、/** */.pyPython#、、docstring.javaJava//、/* */.goGo//、/* */.rsRust//、/* */.rbRuby#.html.xmlHTML / XML!-- --.css.less.sass.scssCSS / Less / Sass/* */.phpPHP//、#、/* */.swift.kt.dart.sol.sqlSwift / Kotlin / Dart / Solidity / SQL语言对应语法.sh.yaml.ymlShell / YAML#.vue.svelteVue / SvelteHTML CSS JS 复合其中.vue与.svelte属于单文件组件使用的是CompositeManipulator会按 HTML → CSS → JavaScript 的顺序依次剥离各区块的注释fileManipulate.ts 第 97-106 行。扩展名匹配对大小写不敏感同文件第 109-116 行Main.JS、style.CSS这类大写扩展名同样会被正确处理。各类注释示例单行注释// 这是一条单行注释 const x 5; // 行尾注释也会被移除多行注释/* * 这是一条多行注释 * 跨越了多行 */ const y 10;文档注释/** * 将两个数相加的函数 * param {number} a - 第一个数 * param {number} b - 第二个数 * returns {number} - 两数之和 */ function add(a, b) { return a b; }HTML/XML 注释!-- 这是一条 HTML 注释 -- div内容/divPython 注释与 docstring# 这是一条 Python 注释 x 5 # 行尾注释 这是一段多行 Python docstring 底层实现原理注释移除的实现在 src/core/file/fileManipulate.ts 中核心是StripCommentsManipulatorremoveComments(content: string): string { const result strip(content, { language: this.language, preserveNewlines: true, }); return rtrimLines(result); }它基于repomix/strip-comments库按语言进行真正的词法级别解析而非简单的正则替换这是它能正确处理字符串字面量、嵌套引号等边界情况的关键。preserveNewlines: true保证删除注释后保留原有的空行结构随后rtrimLines会去除每行行尾的空白。getFileManipulator(filePath)通过path.extname取扩展名并查找映射表找不到对应语言时返回null此时注释移除对该文件静默跳过不会报错。在整体处理流水线中的位置注释移除不是最后一步它在文件处理流水线中有明确的先后顺序。从 src/core/file/fileProcess.ts 第 18-19 行和第 76-82 行的注释可以确认完整的变换顺序[removeComments → compress]worker 线程 → truncateBase64 → removeEmptyLines → trim → showLineNumbers添加行号要点如下先删注释再压缩removeComments与compress同属重变换在 worker 线程池中按顺序执行fileProcessContent.ts 第 28-30 行先调用manipulator.removeComments再在第 37-53 行尝试 tree-sitter 压缩保证压缩时处理的是已无注释的源码。性能自动优化fileProcess.ts 第 111-115 行只在需要压缩或开启removeComments时才启动 worker 线程useWorkers needsCompression || config.output.removeComments否则走轻量主线程路径避免无谓的开销。与 removeEmptyLines 的协同删除注释会产生多余空行removeEmptyLines特意安排在注释移除之后执行第 81-82 行注释二者搭配可得到紧凑输出repomix --remove-comments --remove-empty-lines行号添加在最后开启showLineNumbers时行号基于去注释后的内容重新编号且对压缩文件compress级别自动跳过第 55-60 行。这一顺序在 tests/core/file/processOrderSpec.test.ts 和 tests/core/file/fileProcess.test.ts 中有专门的测试用例覆盖例如removeEmptyLines折叠注释移除产生的空行、removeCommentstrue时走 worker 路径等。测试验证与边界情况仓库的 tests/core/file/fileManipulate.test.ts 为注释移除提供了极为详尽的用例矩阵1100 行这些用例本身就是支持哪些注释的权威答案语言覆盖C、C含.h/.hpp/.cc/.cpp、C#、CSS、HTML、Java、JavaScript、Less、PHP、Python、Ruby、Sass、SCSS、SQL、Swift、TypeScript、XML、Dart、Go、Kotlin、Rust、Shell、YAML、Vue、Svelte 共 20 余种。Python 边界用例docstring 与字符串字面量混合、f-string 中的三引号、嵌套引号、转义井号\#、多行语句中的字符串等确保字符串里的#和不会被误删。Go 特殊处理//go:directive之类的编译器指令会被保留Go directives preservation 用例不会被当作普通注释删除。Vue/Svelte 复合组件验证 HTML、CSS、JS 三个区块各自的注释都能被正确剥离。JS/TS 模块扩展名变体.mjs、.cjs、.mts、.cts、.mtsx全部覆盖。如果你不确定某种语言的注释能否被处理最直接的方式就是查看该测试文件中的对应用例。收益与权衡移除注释的收益降低 Token 使用注释会占用可观的 Token 预算移除后同样的内容量能容纳更多真实代码尤其适合接近模型上下文上限的场景。减少噪音剔除解释性文字后输出更简洁模型更容易聚焦在代码本身。清除敏感信息注释里常常藏着内部网址、密钥片段、个人笔记等敏感内容移除注释等于多了一道脱敏屏障。移除注释的代价丢失上下文注释往往是理解代码意图的重要线索删除后模型可能难以判断为什么这么写。丢失文档JSDoc、docstring 等文档注释承载着函数、参数、返回值的契约信息。需要注意的是这类注释的处理结果依语言与上下文而定例如 Go 指令会被保留不能一概而论。增加理解难度面对没有注释的复杂逻辑模型可能给出泛化甚至错误的推断。何时开启、何时保持关闭建议开启的场景正在逼近模型的 Token 上限需要为更多代码腾出空间希望模型只基于代码本身做分析、重构或测试生成不被注释干扰注释中包含不宜泄露给第三方模型的敏感信息。建议保持关闭的场景代码本身逻辑复杂、依赖注释说明业务规则此时注释是不可或缺的上下文你希望模型理解 API 的设计意图文档注释是重要输入代码量大且注释密度高、但 Token 预算充足保留注释可获得更好的回答质量。完整示例开启前后的输出对比以一段典型的 JavaScript 代码为例开启前含注释/** * 对用户进行身份认证 * param {string} username - 用户名 * param {string} password - 密码 * returns {boolean} - 认证是否成功 */ function authenticateUser(username, password) { // 从数据库获取用户 const user getUserFromDatabase(username); // 如果用户不存在返回 false if (!user) { return false; } // 校验密码 return checkPassword(user, password); }执行repomix --remove-comments后function authenticateUser(username, password) { const user getUserFromDatabase(username); if (!user) { return false; } return checkPassword(user, password); }函数签名与业务逻辑完全保留注释与文档块全部消失——Token 占用与噪音同步下降而代码行为没有任何改变。总结注释移除是 Repomix 在为 LLM 打包代码场景下最实用的开关之一一行--remove-comments或配置output.removeComments: true即可生效底层由语言感知的词法解析保证准确性并通过 worker 线程与后续的压缩、去空行、行号等步骤形成一条精心编排的处理流水线。它适合在 Token 紧张、追求信噪比或需要清理敏感信息时开启而在复杂业务代码、API 文档依赖场景下则应权衡保留注释带来的上下文价值。配合 配置指南 与 命令行选项 可以进一步组合出适合你工作流的打包方案。【免费下载链接】repomix Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomix创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考