SuperAPI AI 工具集

naming-things

编程与开发

查看项目

更新于 10-16 01:19

技能介绍

用途:在为变量、函数、类、类型或模块命名、重构重命名、审查名称不清晰或误导的 diff,以及讨论命名、标识符和可读性时使用;若名称由不可更改的外部契约(序列化字段、API schema、协议)决定,或由生态约定强制(紧密数值循环里的 i/j、泛型参数 T、self/this),则不适用。

主要规则:名称长度与作用域成比例,越远离声明越要能独立表意(模块级或导出名用 activeSessionCount 而非 cnt);优先使用问题域词汇而非实现域词汇(employeeRoster 而非 inputRecord,printerReady 而非 bitFlag);布尔名应能读成肯定的事实断言(is_active、has_children、can_retry、done),避免否定形式;带单位的数值把单位写进名称(delay_ms、size_bytes、weight_kg、timeout_s),有条件时用专门类型更强;同一概念在全代码库统一用词,并保持成对动词对称(open/close、begin/end、add/remove)。名称必须诚实:get_user() 不应创建用户,检查函数不应改状态或做 I/O,否则重命名(如 get_or_create_user)或拆分。

反模式:非平凡作用域中的单字母、缩写(cnt、usr)、把类型写进名称(users_array)、缺单位、否定布尔、含糊填充词(DataManager、InfoProcessor)、Base/Abstract 前缀、Utils/Helpers 杂物袋、数字变体(data1、data2)、近似孪生名(userInfo 与 userData)。修复方向分别为写明角色、改用完整词、按领域明确命名、拆分或合并。

限制与信号:资料未提供该技能的安装命令、收费或平台信息。若反复努力仍起不出诚实具体的名字,应视为结构反馈——只能叫 process_and_update 的函数应拆分,只能叫 DataManager 的类职责不清,应调整结构而非硬凑名称。相关技能包括 never-nesting 与 self-documenting-code。