SuperAPI AI 工具集

rewrite-rustdoc

编程与开发

查看项目

更新于 10-15 23:32

技能介绍

用途:该技能用于重写 Rust 文档注释,确保所有 Rust 文档与代码注释仅使用英文,并遵循 rustdoc 指南。适合需要清理含中文注释的 Rust 源码、统一文档语言的场景。

主要能力:识别并修正文档与代码注释中的中文文本;检查缺失的文档;按 rustdoc 指南调整文档结构与风格。测试用例字符串中的中文字符允许保留,中文报告文件不修改,仅处理 Rust 源码文件。

使用方式:先确定要处理的文件,若用户提供查找方式则使用该方式,否则默认处理 src/ 目录。随后执行搜索与检查:用 rg -n "[\u4e00-\u9fff]" src/ 查找源码中的中文字符;用 cd src/ && cargo clippy -- -W missing_docs 检查缺失文档,若用户指定了位置则替换 src/。文档结构与风格标准参考 ./docs/rustdoc-guidelines.md。修正需严格遵循该指南,并迭代重复搜索与修订,直到没有需要修改的内容。过程中不逐项请求确认,完成所有必要更改后再报告。

适用场景:Rust 项目文档本地化清理、开源项目提交前的注释规范化、需要统一英文文档的代码库维护。

限制:仅处理 Rust 源码文件,不修改中文报告文件;测试字符串中的中文无需修改;具体 rustdoc 指南内容取决于项目内 ./docs/rustdoc-guidelines.md,资料未提供其细节;未提供安装命令、收费或平台信息。