SuperAPI AI 工具集

clean-code-naming

编程与开发

查看项目

更新于 10-16 02:39

技能介绍

用途:这是命名专项技能,只处理代码符号命名,包括审查、重命名修正和候选名称建议;结构性问题及其他非命名违规交由 clean-code-refactor 或对应语言工程师处理。

主要能力:三种模式。review 审查 target_path 内所有名称并输出违规报告,含严重级别与建议重命名;fix 在 target_path 内重命名符号并给出前后映射,更新调用点,target_path 之外的使用点仅标记不改;suggest 根据用途描述返回 3 个排序候选名及理由。

必要参数:mode 必填(review|fix|suggest);target_path 在 review、fix 时必填;purpose_description、symbol_type 在 suggest 时必填;language 在 review、fix 时必填(python|javascript|csharp|rust);standard 可选,默认 general,设为 ob 时启用 BORO/Ontoledgy 规范。

标准差异:general 基于 Clean Code 命名原则;ob 叠加 BORO 快速风格指南并以 OB 优先。OB 要求类名 PascalCase 复数、布尔函数以 is_ 或 has_ 开头、禁止 data/tmp/process/handle/res 等模糊名和单字母名(self/cls 除外);Python 私有方法用双下划线;Rust 私有函数仅用 fn、枚举变体单数 PascalCase、生命周期用有意义单词、公开 API 不用元组结构体。

适用场景:重命名重构前审查名称、批量统一命名风格、为新符号起名。限制:只做命名,不做结构调整;fix 不修改 target_path 之外的文件;fix 模式建议在应用后运行对应语言的质量检查命令,但资料未提供具体命令内容。