SuperAPI AI 工具集

naming-conventions

编程与开发

查看项目

更新于 10-15 22:19

技能介绍

用途:审查并重构代码库中命名不清、过度缩写或具有误导性的标识符,包括变量、函数、参数、文件和模块,将其替换为一致且能表明意图的名称。

主要能力:按五类问题扫描代码——隐秘的极短名称(如 d、tmp、cb)、含糊通用名称(如 data、result、handleStuff)、误导性或与行为矛盾的名称(如返回错误信息的 isValid)、不一致的命名模式(如 getUser、fetchUserData、loadUser 混用),以及过度缩写的领域术语(如 usr、acct)。对每个被标记的名称给出重命名建议,格式为类别、旧名→新名、位置、原因。

建议原则:变量命名概念而非容器;布尔值使用积极、现在时的谓词前缀(is、has、can、should);函数采用动词+名词并体现副作用;参数具体化;文件与模块名匹配主要导出。同时给出按代码库统一的动词词汇建议,例如从 API 读取用 fetch、从存储读取用 get、写入用 save、删除用 delete、转换用 format,若已有既定模式则沿用而非强加新规则。

使用方式:当出现显式重命名请求、可读性抱怨、代码评审前清理、新人上手困难或审计命名等场景时触发。流程为:第一步审计并按类别标记问题;第二步提出重命名建议;第三步按优先级分组输出(误导性名称优先,其次难懂名称、不一致模式、缩写);第四步在用户确认后应用重命名,检查所有引用(声明、调用点、导入、注释、测试文件),保留导出与公共 API,并在重命名公共名称前提示破坏性变更;第五步输出审计摘要报告。

适用场景:需要清理代码命名、统一风格、为代码评审或新人上手做准备的各类项目。

限制:资料未提供具体安装命令、收费或价格信息、运行平台与效果数据;触发方式、应用范围与语言约定说明为技能内描述,实际使用需结合具体代码库与用户确认。