用途:在不改变功能(除非明确要求)的前提下提升代码可读性,降低人类读者与智能体的认知负担,并应用合适的惯用最佳实践。
主要能力:接受完整源文件(如 .proto、.go、.py、.md 等)、部分注释(包头部、方法文档、行内说明)、完整或部分函数,以及任意代码片段或上述混合内容。处理时保留所有标识符(字段、参数、类、方法等),增加策略性空白以提升可读性,尽可能把段落式注释转为项目符号,信息呈列表状时优先使用项目符号。
使用方式:将代码或注释作为输入提交,返回结果用三重反引号包裹。除非被要求,不删除或修改原始内容。
团队特定边界情况:保持 TODO_???(???) 标签不变;保留 IMPORTANT、DEV_NOTE 等提示;维护对 GitHub issue/PR 的引用(如“As of #XX ...”);保留每个链接与外部引用;保留 CRITICAL、NB、DEV_NOTE、NOTE 等标记,仅清理其后的文本。
长片段处理:对约 5 行成组代码后接空行的情况,在块顶部添加简短注释;保持现有注释层级,仅增强可读性。
细节与编辑:不要创建仅含单个条目的列表,应写成纯文本;编辑时绝不删除现有链接。
限制:资料未提供安装命令、收费、价格、平台或效果等信息。