SuperAPI AI 工具集

code-naming-auditor

编程与开发

查看项目

更新于 10-15 17:31

技能介绍

用途:本 Skill 指导 AI Agent 对代码库执行命名审计,确保其遵循明确定义的术语与命名规范,在项目中强制执行“通用语言”,提升代码清晰度、一致性与可维护性。使用期间输出避免 Markdown 表格,改用无格式文本列表。

工作流: 一、建立术语表。先在 docs/ 或根目录查找 glossary.md、terminology.md 等文档;若找到,向用户确认是否为本次审计的事实之源;若不存在,说明其重要性,并用 references/glossary_template.md 模板引导用户创建。术语表需精确定义核心名词(如 Content、Section、Line)与动词(如 get、find、search、list)的语义,命名应精确、足够特殊,避免模糊歧义。未达成清晰且双方同意的术语表前不应继续。 二、定义审计范围。询问用户要审计的目录或文件,并确认范围。 三、分析与报告。逐个读取文件,检查方法/函数名、参数名、变量名、类型名/别名,对照术语表,重点关注动词错用(如该用 search 却用 find)、名词不一致(如代表多行内容的 string[] 命名为 lines 而非 Content)、模糊命名(如 data、item、val、str)。为每个文件汇总偏差清单,记录位置、问题描述与明确修改建议,最后按文件分组呈现。 四、实施重构(可选)。提交报告后询问用户是否应用修正;若同意,用 replace 工具逐一或按小批次应用,完成后最好运行测试套件验证无回归。

限制:具体支持的语言、平台与工具依赖资料未提供;重构需用户确认,术语表缺失时无法进入审计。